Sphinx extension to build Atlassian Confluence Storage Markup
Project description
Sphinx extension to build Confluence® compatible markup format files and optionally publish them to a Confluence instance.
Requirements
Confluence Cloud or Data Center / Server 7.13+
Python 3.7+
Requests 2.14.0+
Sphinx 5.3+
Installing
The recommended method to installing this extension is using pip:
pip install sphinxcontrib-confluencebuilder
(or)
python -m pip install sphinxcontrib-confluencebuilder
For a more in-depth installation information, see also:
Atlassian Confluence Builder for Sphinx - Installation
Usage
Register the extension sphinxcontrib.confluencebuilder in the project’s configuration script (conf.py):
extensions = [
'sphinxcontrib.confluencebuilder',
]
Run sphinx-build with the builder confluence:
sphinx-build -b confluence . _build/confluence -E -a
(or)
python -m sphinx -b confluence . _build/confluence -E -a
For more information on the usage of this extension, see also:
Atlassian Confluence Builder for Sphinx - Tutorial
Configuration
The following is an example of a simple configuration for Confluence generation and publishing:
extensions = [
'sphinxcontrib.confluencebuilder',
]
confluence_publish = True
confluence_space_name = 'TEST'
confluence_parent_page = 'Documentation'
confluence_server_url = 'https://intranet-wiki.example.com/'
confluence_ask_user = True
confluence_ask_password = True
For a complete list of configuration options, see also:
Atlassian Confluence Builder for Sphinx - Configuration
Features
For a complete list of supported markup, extensions, etc.; see:
Atlassian Confluence Builder for Sphinx - Features
For a complete list of directives supported by this extension, see:
Atlassian Confluence Builder for Sphinx - Directives
Demonstration
A demonstration of this extension can be seen by inspecting the published validation/testing documents found here:
Atlassian Confluence Builder for Sphinx - Online Demo on Confluence Cloud
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinxcontrib_confluencebuilder-2.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa06a7f7a66d68fb1be55047dd4165495aac1c765520011a8a31b1a109827502 |
|
MD5 | 308097bcd9bccdc8f1c40a9036e4a4a0 |
|
BLAKE2b-256 | 6df702722a018c5d52192e80c5b59af7913bfe05db0c021b37c504d7f267893a |
Hashes for sphinxcontrib_confluencebuilder-2.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1ec01371177da74a0daa54dab6d6c87a8e1a06bc940d5eb6ef27b510b458bd3 |
|
MD5 | e6ca32eac271ea3fb403f4561dec7ea0 |
|
BLAKE2b-256 | ba34200544f4ece1d7fcb97331c940990acd532c6a7b34bfb8251eb41df68a7e |