sphinxcontrib-confluencebuilder

What it is and what it does

This is a Sphinx extension that translates documentation written in reStructuredText into Atlassian Confluence Storage Markup, the native format Confluence uses internally. It sits between your Sphinx documentation build pipeline and a Confluence instance, allowing you to maintain docs in Sphinx while publishing them to Confluence for team access.

The extension works by registering a new builder with Sphinx (invoked via `sphinx-build -M confluence`), which processes your documentation source and generates Confluence-compatible markup. It can optionally publish the output directly to a Confluence Cloud or Data Center instance using HTTP requests, handling authentication and page hierarchy management. Configuration is done through Sphinx's standard `conf.py` file, where you specify target space, parent page, server URL, and credentials.

Use it for:

• Publish Sphinx-based technical documentation to a team Confluence wiki without manual conversion or duplication.
• Maintain a single source of truth in reStructuredText while serving both HTML and Confluence outputs from one build.
• Automate documentation deployment to Confluence as part of a CI/CD pipeline.
• Convert existing Sphinx projects to Confluence format for organizations standardized on Atlassian tools.
• Generate Confluence pages from API documentation or code docstrings processed by Sphinx.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Sphinx extension that converts reStructuredText documentation into Atlassian Confluence Storage Markup format and optionally publishes it to a Confluence instance.

Yes, if you use Sphinx for documentation and need to publish to Confluence. The extension is actively maintained, has no known vulnerabilities, low install friction, and a permissive license. It solves a real workflow problem—keeping docs in sync across two platforms—without requiring manual conversion. Suitable for teams already invested in both Sphinx and Confluence.

Install

sphinxcontrib-confluencebuilder on PyPI

pip install sphinxcontrib-confluencebuilder

uv add sphinxcontrib-confluencebuilder

poetry add sphinxcontrib-confluencebuilder

Installing sphinxcontrib-confluencebuilder

Before you install

Low friction install as a pure-Python wheel. Actively maintained with a recent release (13 days old) and steady repository activity. Requires Python 3.10+ and Sphinx 8.0+, with requests 2.30.0+ as the other runtime dependency.

License in practice

BSD-2-Clause permissive license allows commercial and private use with minimal restrictions; suitable for most projects.

Quickstart

pip install sphinxcontrib-confluencebuilder

# In conf.py:
extensions = ['sphinxcontrib.confluencebuilder']

# Build:
sphinx-build -M confluence . _build -E -a

Requires Python 3.10+, Sphinx 8.0+, and Requests 2.30.0+; target Confluence instance must be Cloud or Data Center 9.1+.

Verify before relying

• Whether the extension handles all reStructuredText directives or only a subset of Sphinx markup
• Performance characteristics when publishing large documentation sets to Confluence
• Authentication methods supported beyond user/password (e.g., API tokens, SSO)

Package facts

Evidence: sphinxcontrib_confluencebuilder-3.2.0-py3-none-any.whl

Tags

More Utilities packages