Sphinx extension to build Confluence storage format files and optionally publish them to a Confluence instance.
If publishing:
- Confluence Cloud or Server 6.7+
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/en/latest/install.html
- Register the extension
sphinxcontrib.confluencebuilder
in the project's configuration script (conf.py
):
- 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/en/latest/tutorial.html
The following is an example of a simple configuration for Confluence generation and publishing:
For a complete list of configuration options, see also:
Atlassian Confluence Builder for Sphinx - Configuration
https://sphinxcontrib-confluencebuilder.readthedocs.io/en/latest/configuration.html
For a complete list of directives supported by this extension, please consult:
Atlassian Confluence Builder for Sphinx - Directives
https://sphinxcontrib-confluencebuilder.readthedocs.io/en/latest/directives.html
The set of example documents used to assist in validation/testing can be found here:
Atlassian Confluence Builder for Sphinx - Validation Set
https://github.com/sphinx-contrib/confluencebuilder/tree/master/test/validation-sets
The active and older versions of published validation documents can be found here:
Atlassian Confluence Builder for Sphinx - Online Demo on Confluence Cloud
https://jdknight.atlassian.net/wiki/spaces/confluencebuilder/
For a complete list of supported markup, consult the following:
Atlassian Confluence Builder for Sphinx - Markup
https://sphinxcontrib-confluencebuilder.readthedocs.io/en/latest/markup.html