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.14+
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.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6697b69f5df569f9eae0885010466daaebd2124923bffbb39d7b76b508467d90 |
|
MD5 | 26544956dc619967d0589b19caa1bde6 |
|
BLAKE2b-256 | 0ebaec4efa9b34d43fe01943b12214044d5079271f029f885c4ab806d9910806 |
Hashes for sphinxcontrib_confluencebuilder-2.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb47653118df9ddad8024df25fd6b17f7b570a6757626faaf7a64a57311de908 |
|
MD5 | ed3fde728dc2348e828ef5fd851beedf |
|
BLAKE2b-256 | 1ef847875cbf654fefd5a66e202be4730a041a5805dbc1c15e3bd5cea5ea72aa |