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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9bdaae283fec5e2b6ce7afcf07a8343b41ac1f22597734a95ac1483f3e7e17c |
|
MD5 | 81dccfd22f02140835ee16e979c17c61 |
|
BLAKE2b-256 | b7751174835eaf9dc0bb50d996350d2a10f57a9225593e4e50ccda8e62520453 |
Hashes for sphinxcontrib_confluencebuilder-1.7.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95ad2270571681491ffbb7f6bbe453c1e4c797aff79528ca2c521a9a85987308 |
|
MD5 | 7501aece1c69296d87476db268e80866 |
|
BLAKE2b-256 | 4ad547a66a9425248c45563f72518e470f1049f296283c64d083547787482f8a |