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
Active release (v1.9) requirements:
Confluence Cloud or Data Center / Server 7.8+
Python 2.7 or 3.7+
Requests 2.14.0+
Sphinx 1.8 or 4.1+
Next release requirements:
Confluence Cloud or Data Center / Server 7.11+
Python 3.7+
Requests 2.14.0+
Sphinx 5.0+
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-2.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4724a142dfedf2d9c4e591ccd160d0fa3aef5de9b7cb6e2d0a98f7b3a4e1abe8 |
|
MD5 | 152d289f804a79e60dbb701dc7dd3fda |
|
BLAKE2b-256 | 955519c9a8d693379447473facdfab5577530182c5112161f3ee101a0e07d1e7 |
Hashes for sphinxcontrib_confluencebuilder-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8ff24b380c6ee4b3c736382b9b7da81bc345cd66a0ef0d56891bef79eff8d49 |
|
MD5 | 86f60a0ee061b885089bc84cabc2c15e |
|
BLAKE2b-256 | e35f2d13af11d7a80845474c07b369f2dd237a0e810b77a8d3f7db06f21ac554 |