Sphinx extension to output Atlassian Confluence Wiki files and publish to Confluence Servers.
Project description
Sphinx extension to build Confluence storage format files and optionally publish them to a Confluence instance.
Requirements
If publishing:
Confluence Cloud or Server 6.1+
Installing
The recommended method to installing this extension is using pip:
pip install sphinxcontrib-confluencebuilder
For a more in-depth installation information, see also:
Atlassian Confluence Builder for Sphinx - Installation
Usage
Set the builder sphinxcontrib.confluencebuilder in the as an extension in 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 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_server_user = 'username'
confluence_server_pass = 'password'
For a complete list of configuration changes, see also:
Atlassian Confluence Builder for Sphinx - Configuration
Demonstration
The set of example documents used to assist in validation/testing can be found here:
Atlassian Confluence Builder for Sphinx - Validation Set
The active and older versions of published validation documents can be found here:
Atlassian Confluence Builder for Sphinx - Online Demo on Confluence Cloud
Supported Markup
For a complete list of supported markup, consult the following:
Atlassian Confluence Builder for Sphinx - Markup
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.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9c36e56efeface810f5cefdac2d06e326533eacab59352edcd81291bf283468 |
|
MD5 | 661f767ddecab00c90927a6b777e03d4 |
|
BLAKE2b-256 | 77d5121c480992c51469c04dd90eafc7b8942a9f8231b28e53ce074c57c76df8 |
Hashes for sphinxcontrib_confluencebuilder-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63c0e9285a85df17a839b6c51e531d34b4a7566fc89a2a224ef269227e5f15ae |
|
MD5 | 47eafd04ee61f45a3bf646adfdad0641 |
|
BLAKE2b-256 | f9fbb3ef5f3bce83db17fe2fc58c5a019e82346d8e6fd2fef5b9c28618bb277d |