Sphinx extension to build Confluence® compatible markup format files and optionally publish them to a Confluence instance. It supports both Confluence Cloud and Data Center deployments. The current version is 3.1.0, with regular updates typically following Sphinx and Confluence API changes.
pip install sphinxcontrib-confluencebuilderVerified import paths — ran on the pinned version, not inferred.
To quickly get started, add `sphinxcontrib.confluencebuilder` to the `extensions` list in your Sphinx project's `conf.py`. Then, configure the essential publishing options, including your Confluence server URL, space key, and authentication credentials (preferably an API token via environment variable). Finally, execute Sphinx with the `confluence` builder to generate and publish your documentation.
Review Confluence page rendering post-upgrade. If issues occur, adjust content or set `confluence_editor = 'v1'` in `conf.py` if 'v1' is still supported by your Confluence instance and desired.
Consult the latest documentation for equivalent or new configuration options. Replace any removed options. For `confluence_editor`, consider if `v2` is acceptable or if `confluence_cloud` and `confluence_publish_token` options provide necessary alternatives for modern Confluence environments.
Upgrade your Python environment to 3.10 or newer to use versions 2.16+ of `sphinxcontrib-confluencebuilder`.
Remove `confluence_asset_force_standalone` from your `conf.py` as its behavior is now default. Avoid using page-specific editor overrides and transition to global or builder-specific configurations if possible.
Use environment variables (e.g., `os.environ.get('CONFLUENCE_PUBLISH_TOKEN')`), a secure credential manager, or prompt for credentials at build time (e.g., `confluence_ask_password = True`) to keep secrets out of source control.