Build Status PyPI

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-bridge

Setup

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
  • 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.

Project links

Data verified by PyPI on Aug 16, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for adamtheturtle from gravatar.com adamtheturtle

Credits

Author: Adam Dangoor

GitHub Statistics

Data verified by PyPI on Aug 16, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.11

Provides Extra

dev release

Tags

confluence documentation rst sphinx

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_confluencebuilder_bridge-2026.8.16.tar.gz (396.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_confluencebuilder_bridge-2026.8.16-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_confluencebuilder_bridge-2026.8.16.tar.gz.

File metadata

File hashes

Hashes for sphinx_confluencebuilder_bridge-2026.8.16.tar.gz
Algorithm Hash digest
SHA256 e3ffc85b643e5eeaa20d3a8c903778cc21aef570753ddd429bb1a04fd5b44e37
MD5 213edab84930d4fbd5632d45771bf98d
BLAKE2b-256 000734de88be985077f37d985318c9e02408994003d629b14cb2ced75bd6e0a9

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_confluencebuilder_bridge-2026.8.16.tar.gz:

Publisher: release.yml on adamtheturtle/sphinx-confluencebuilder-bridge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinx_confluencebuilder_bridge-2026.8.16-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_confluencebuilder_bridge-2026.8.16-py3-none-any.whl
Algorithm Hash digest
SHA256 a633a5eb4e7eba2ef185fb22b7473bfe213898ad181b0391dc405d9aa9f4b818
MD5 826bd00b49cb741a52e36316303449f3
BLAKE2b-256 fe9084aeb7727e9581c1e0948b53f52d5db9ac8e84f33f752930f873c246d7e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_confluencebuilder_bridge-2026.8.16-py3-none-any.whl:

Publisher: release.yml on adamtheturtle/sphinx-confluencebuilder-bridge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page