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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | eca6def339e3fb1722331d365c7663700955a90faad0f13fa731426d38a2524a |
|
MD5 | 53b692cc4de4c762becca5d98004bbd2 |
|
BLAKE2b-256 | a0a0d9752807699790474c85dfd55c53e634c12dd561d4b0bb2037292326b766 |
Hashes for sphinxcontrib_confluencebuilder-2.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c22ff8ed52dd2ea934db6e111b0c5d7f6d485722593fd8a121a80120da5688dc |
|
MD5 | 96d29556822706899833979cc26e70a4 |
|
BLAKE2b-256 | b69237c06ac545fd3888c514efb4d6c8ac1df23aa2a167095292542f904d1953 |