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.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbf72014bc78f392c092141101f4fff38bfd3bfdec04b3f64892b30a3dc90d1d |
|
MD5 | 267bff850e5b157c6d8ac31b375421b9 |
|
BLAKE2b-256 | 7aa2cde953c12f46f6147a2a1e2640a32a5f7e0b36febb063d4506dde6a49c2f |
Hashes for sphinxcontrib_confluencebuilder-1.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 507a5323812dfed0d1478878f8eb18b56b3e026f0796f058d27b1602d6901d4d |
|
MD5 | 8f09a173bb3b58023f257d955c46802b |
|
BLAKE2b-256 | d60ad0fbcf2afee17771ee20c4f9805a321c84924cbd378587547beeb166dae1 |