Sphinx extension to output Atlassian Confluence Storage Markup documents and publish to Confluence instances.
Project description
Sphinx extension to build Confluence® compatible markup format files and optionally publish them to a Confluence instance.
Requirements
If publishing:
Confluence Cloud or Data Center / Server 7.4+
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-1.8.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbeb23863ff67eef1f2c645bdb3827348fb2ef02085184cc26145e92b76d31e5 |
|
MD5 | ac0f5ca1f495fa72d276840088051cb6 |
|
BLAKE2b-256 | 6dbbf7124482a20dffcd97ea899bfdcd0547c79b1f612dd3b71dcc8ba16c8702 |
Hashes for sphinxcontrib_confluencebuilder-1.8.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 868161f11ecdb87c41c2303d354f45d7ebd558127abc0eaa250f29c7a1f46af9 |
|
MD5 | b5944eceb8b1aa716d8fcf425c69475b |
|
BLAKE2b-256 | c74b0fbcce21f5117a919ea3406e24595c88fe2114a9b516823a3d4147fbebef |