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
If publishing:
Confluence Cloud or Data Center / Server 7.8+
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.9.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a3fbcfd9396a53d7305d0938ade99a3f5e19f3162b0b93faeb83997ab0f9a4c |
|
MD5 | 0a365bd6f9fc84ff8575efa7efbe8cca |
|
BLAKE2b-256 | 3c65d69956e92464f818c4bbf4a4f84ec6fc6370c40d75589053231b9f57c798 |
Hashes for sphinxcontrib_confluencebuilder-1.9.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6921602f9f39629d277f59f18a1ab7033b78d474eed5a02d54ae69e1e3629e07 |
|
MD5 | 28b875a55a6ba741e24823415268c89c |
|
BLAKE2b-256 | cd225fbee0a0a19617c5152b343362a12ef01c0e70330cd7d63af55faee07314 |