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.2+
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.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5372b814000ce8207be2add03d3cd8a1309bd9bada8f035269b0d645a4a8190 |
|
MD5 | ea5383b9cae7f2db8782d673cc73c790 |
|
BLAKE2b-256 | c314cbbd98d0b3bade05af811a9e06d50e12c520fbfff33aad416847d3513d68 |
Hashes for sphinxcontrib_confluencebuilder-1.7.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4bff086e440af45f624c6b0c6e046f9426a6c42e684daf353b9497bc6c2d1f66 |
|
MD5 | 5f5399f76da9d55ed9d29ddd2d964b02 |
|
BLAKE2b-256 | 63f6ed1050903334da90a71f678e7e1c31f0a027fd0f82ef8b4552ed0d843833 |