Sphinx Confluence Builder Bridge
Extension for Sphinx which enables using directives and roles from Atlassian® Confluence® Builder for Sphinx in other Sphinx builders such as HTML. This enables you to use HTML builds for easy iteration while developing documentation which is primarily meant for Confluence.
Installation
sphinx-confluencebuilder-bridge is compatible with Python 3.11+.
$ pip install sphinx-confluencebuilder-bridgeSetup
Add the following to conf.py to enable the extension:
"""Configuration for Sphinx."""
extensions = ["sphinxcontrib.confluencebuilder"] # Example existing extensions
extensions += [
# This must come after ``"sphinxcontrib.confluencebuilder"``
"sphinx_confluencebuilder_bridge"
]Supported directives
Only some of the directives supported by Atlassian® Confluence® Builder for Sphinx are supported. The following directives are supported:
- confluence_toc
The only supported option is max-level.
- confluence_viewpdf
HTML output builders only (e.g. html, dirhtml, singlehtml).
Requires the PDF to be in a directory specified in html_static_path.
Supported roles
Only some of the roles supported by Atlassian® Confluence® Builder for Sphinx are supported. The following roles are supported:
- confluence_link
This renders as a normal hyperlink, unlike in Confluence where the page title is shown.
- confluence_doc
This renders as a normal documentation link, unlike in Confluence where the page title is shown.
- confluence_mention
This renders as a link with the text being the user’s account identifier, user key or username.
For this to show a clear account identifier, set confluence_mentions in conf.py.
Contributing
See CONTRIBUTING.rst.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-confluencebuilder-bridge 2026.10.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_confluencebuilder_bridge-2026.10.9.tar.gz | 397.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_confluencebuilder_bridge-2026.10.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 404.0 kB
Release files / sphinx_confluencebuilder_bridge-2026.10.9.tar.gz
| Download URL | sphinx_confluencebuilder_bridge-2026.10.9.tar.gz |
|---|---|
| Size | 397.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
03d03e0ad19d50cee83dd92b0b125f60f403be4daca2254f5409ff5f1e7535ee
|
|
BLAKE2b-256 checksum How to use checksums |
cb48e0d1239711ecaca75fe9bd9d8ba9e52e651612fbc7701e4fc4053f2c9926
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / sphinx_confluencebuilder_bridge-2026.10.9-py3-none-any.whl
| Download URL | sphinx_confluencebuilder_bridge-2026.10.9-py3-none-any.whl |
|---|---|
| Size | 6.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
631ff4066cc5ab2403717282864232f494630f8a01b762a16c0c90b7626c1c5f
|
|
BLAKE2b-256 checksum How to use checksums |
71ead39a8f6718df9dc843f3177af8e289474895718f871d126891798dc42ded
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency log
