Sphinx extension to output Atlassian Confluence Wiki files and publish to Confluence Servers.
Project description
Sphinx extension to build Confluence Wiki markup formatted files and optionally publish them to a Confluence instance.
Requirements
If publishing:
Confluence Cloud or Server 5.9+
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
Bulleted Lists
Citations
Code Blocks
Definitions
Enumerated Lists
Footnotes
Headings
Hyperlinks
Indentations
Inline Blocks/Literals
Paragraphs
Tables
TOC Tree
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-0.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45e026c7ac2ed826a5ed627dae1da14c4db35d3d22b779faa398f0614cbe91c7 |
|
MD5 | 2e644141572ac476b9a1a60680cbf206 |
|
BLAKE2b-256 | 9a25ab0407e9db8cef537e40386da0ed7e2e8b54e2e9757f616f7c5634380b41 |
Hashes for sphinxcontrib_confluencebuilder-0.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1cd9ba4a91369c536094fd1e141238448d55a3d07639fdb2cafb3b79f75e50a |
|
MD5 | a4de4c0a824f889076d9c6f3a9d83b93 |
|
BLAKE2b-256 | dbf6f67c2c397c15e5a7b645e4ed5470d83550c8f3166ece2c54d44798c4d959 |