Sphinx extension to output Atlassian Confluence Storage Markup documents and publish to Confluence instances.
Project description
Sphinx extension to build Confluence storage format files and optionally publish them to a Confluence instance.
Requirements
If publishing:
Confluence Cloud or Server 6.13+
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_server_user = 'username'
confluence_server_pass = 'api-key-or-password'
For a complete list of configuration options, see also:
Atlassian Confluence Builder for Sphinx - Configuration
Directives
For a complete list of directives supported by this extension, please consult:
Atlassian Confluence Builder for Sphinx - Directives
Demonstration
The set of example documents used to assist in validation/testing can be found here:
Atlassian Confluence Builder for Sphinx - Validation Set
The active and older versions of published validation documents can be found here:
Atlassian Confluence Builder for Sphinx - Online Demo on Confluence Cloud
Compatibilities
For a complete list of supported markup, extensions, etc.; consult the following:
Atlassian Confluence Builder for Sphinx - Compatibilities
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-1.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0cf1f439ec5d303bfb69e64a351522a8554ed1b3ab6cb423ef47de3cf851c88 |
|
MD5 | 60607cedbd7e33a0dc19ff0f85799d0c |
|
BLAKE2b-256 | fa78e114cf36ef212f19ffe62aba24c5be949e2d8cf2bffd728289bfbd6fe1bb |
Hashes for sphinxcontrib_confluencebuilder-1.3.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00dbdab683c1a8dda0cc68b3b5e45ac22817ea91abb524287e71333eaa080684 |
|
MD5 | fe58f980b696f701c41204b62b0cd67f |
|
BLAKE2b-256 | 9e42ec405b2dbada556f4556cde98c3eb9525264a88dd59ca594c4921c116e3f |