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 Data Center / Server 7.1+
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.; consult the following:
Atlassian Confluence Builder for Sphinx - Features
For a complete list of directives supported by this extension, please consult:
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.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b39f577151f1f3eb6f2b98353d253a6940864007f50fda8e77f6c99e6f56304e |
|
MD5 | f40247cdca50ae7e4c2bede03663dc2a |
|
BLAKE2b-256 | 72b0b8f85ab6ce8af41dcba7fad4ee01f1b19301bc2a3ca7ee38ccf7b07e2148 |
Hashes for sphinxcontrib_confluencebuilder-1.6.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a67304bb4145af72a340a2e764c08d03bdfa9ea4cb4da980562e3d9ad3ca20fc |
|
MD5 | e3c0f28ca7ace7e2dbcb7f554edbbcbf |
|
BLAKE2b-256 | e67e7c1ee1ddfdfd6ae73e5a161e8ce10fcb45b0484d0510f25bb835167319bb |