sphinx-confluencebuilder-bridge 2025.7.11

Extension for Sphinx which enables using directives and roles from Atlassian® Confluence® Builder for Sphinx in other Sphinx builders such as HTML.

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.

Contents

• Sphinx Confluence Builder Bridge

  • Installation

  • Setup

  • Supported directives

  • Supported roles

  • Contributing

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

  • The only supported option is max-level.

• confluence_viewpdf

  • This shows an inline image which is a screenshot of the first page of the PDF.

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.