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 / Server 7.18+
- 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.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
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.
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.5.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d0a64c10f795152700c64c0ab5c5d712bddd3b159a597c0ff88eadf2c2531ab |
|
MD5 | 9d13e8c1c1080456f0d5afdf3d7b1c97 |
|
BLAKE2b-256 | 216baca56f1e73d12a1d6c4ab5d5a62e87aa2c96ee1712be9be179cd5923a39e |
Hashes for sphinxcontrib_confluencebuilder-2.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b90565f9f4b533789066fe3bfd86202bfade69994ecacc49523748ed3cde4b33 |
|
MD5 | 03d29b7bd0502f57c2287d6084fc286c |
|
BLAKE2b-256 | dba104000688fc44905ac5e0777d9a8e729fa0357379b520ab869bc1d3fadbf9 |