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
Confluence Cloud or Data Center / Server 7.13+
Python 3.7+
Requests 2.14.0+
Sphinx 5.3+
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.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5b07adbca5de6b2370990e104a6b7df91dfc6d3befcf4775fb99a3d42a89bf8 |
|
MD5 | ffcf84bd288677f9e7c5f61ef0823adb |
|
BLAKE2b-256 | b3e71f8414839daef620bafd8008be245a2588bcae6e776d0f55c264c17330b0 |
Hashes for sphinxcontrib_confluencebuilder-2.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c4dfdde7014210bffdba2fe2917767deb94bc87b2ddaf9f04d18799a29ed0e9b |
|
MD5 | d8c0039287709c25cc1725f714931797 |
|
BLAKE2b-256 | 2c6d42f8e89cd6906166df00f62e17679f5092df134418611edea3678c87400a |