Sphinx extension to build Atlassian Confluence Storage Markup
Project description
Atlassian Confluence Builder for Sphinx
Sphinx extension to build Confluence® compatible markup format files and optionally publish them to a Confluence instance.
Requirements
- Confluence Cloud or Data Center 7.19+
- Python 3.8+
- Requests 2.25.0+
- Sphinx 6.1+
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
https://sphinxcontrib-confluencebuilder.readthedocs.io/install
Usage
- Register the extension
sphinxcontrib.confluencebuilderin 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
https://sphinxcontrib-confluencebuilder.readthedocs.io/tutorial
Configuration
The following is an example of a simple configuration for Confluence generation and publishing:
extensions = [
'sphinxcontrib.confluencebuilder',
]
confluence_publish = True
confluence_space_key = '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
https://sphinxcontrib-confluencebuilder.readthedocs.io/configuration
Features
For a complete list of supported markup, extensions, etc.; see:
Atlassian Confluence Builder for Sphinx — Features
https://sphinxcontrib-confluencebuilder.readthedocs.io/features
For a complete list of directives supported by this extension, see:
Atlassian Confluence Builder for Sphinx — Directives
https://sphinxcontrib-confluencebuilder.readthedocs.io/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
https://sphinxcontrib-confluencebuilder.atlassian.net/
Atlassian Confluence Builder for Sphinx project is unaffiliated with Atlassian.
Atlassian is a registered trademark of Atlassian Pty Ltd.
Confluence is a registered trademark of Atlassian Pty Ltd.
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.6.1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f729987f12f9d190c694bce8d8b5e2067ba8dacbd6c67977ec7fdce843400a30 |
|
| MD5 | 4938fa956c301fcc60c28515d9ed084c |
|
| BLAKE2b-256 | 7038c8f015ceaf52bc96c303ca665d433e50382e9d879a9d8b73b52f4339f142 |
Hashes for sphinxcontrib_confluencebuilder-2.6.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 77697dfb6109cb5d8a1a01c1022ffce83f06ee1710bd5a0a134bed90141410a7 |
|
| MD5 | 88dd2c094e35e1ec7eb3295d45e3024c |
|
| BLAKE2b-256 | 0d34b1b02648eb6c047375a2614295a9d99f8a1f3a6a3cbcdd6c8fc4497b5a9f |
