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.16+
Python 3.8+
Requests 2.14.0+
Sphinx 6.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.; 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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab7f86c0c556311bb8796c1b75771b3d0ce906105771910c153a5b10efad78b9 |
|
MD5 | 3a1b176fc082853ca44c003e1ccd840b |
|
BLAKE2b-256 | 99b909a0b14e5e0ae3a57b3701077e24992725be798291124067e8f6205db1b7 |
Hashes for sphinxcontrib_confluencebuilder-2.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3e375c97f3fede1784cf7989ba9055edede2264e401559a9e7c3510425aed48 |
|
MD5 | a96a3fef794a6bead0b51c93788a886d |
|
BLAKE2b-256 | 380455e7074883bc944a40ed030007a9c1443e34406d8e1b2848dd2283af4726 |