sphinxcontrib-confluencebuilder
Sphinx extension to build Atlassian Confluence Storage Markup
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10+, Sphinx 8.0+, and Requests 2.30.0+; target Confluence instance must be Cloud or Data Center 9.1+.
- Low friction install as a pure-Python wheel.
- Actively maintained with a recent release (13 days old) and steady repository activity.
License · maintenance · safety
BSD-2-Clause (permissive) — BSD-2-Clause permissive license allows commercial and private use with minimal restrictions; suitable for most projects.
last release 2026-08-01 (13 days) · last repo commit 2026-08-01 · 352 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 514,884 downloads/mo, #6,235 on PyPI
Alternatives
Verify before relying
pip install sphinxcontrib-confluencebuilder
# In conf.py:
extensions = ['sphinxcontrib.confluencebuilder']
# Build:
sphinx-build -M confluence . _build -E -a- 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)
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 on it.
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
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.
Requires Python 3.10+, Sphinx 8.0+, and Requests 2.30.0+; target Confluence instance must be Cloud or Data Center 9.1+.
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 -aVerify 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
| License | BSD-2-Clause permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagesrequestssphinx |
| Maintenance | Actively maintained 13 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 514,884 / month, #6,235 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: ConsoleEnvironment :: Web EnvironmentFramework :: SphinxFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: DocumentationTopic :: Documentation :: SphinxTopic :: Utilities |
Evidence: sphinxcontrib_confluencebuilder-3.2.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx confluence builder”
- sphinxcontrib-confluencebuilderSphinx extension that converts reStructuredText documentation into…
- atlassian-doc-builderProgrammatically generate and validate Atlassian Document Format…
- sphinx-simplepdfSphinx-SimplePDF is a Sphinx extension that converts Sphinx…
Give your agent the search over MCP, or paste the wish link into any chat.
More Utilities packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Detects and normalizes text encoding from unknown or ambiguous sources, supporting all IANA character sets that Python's core library provides codecs for, with the ability to register custom codecs.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
Pluggy provides a plugin system that lets you define hook specifications and register implementations to be called in sequence, enabling extensible Python applications without tight coupling.
Install it if you're building an extensible application or framework.
Pygments is a syntax highlighter that colorizes source code and text in over 500 languages and formats, outputting to HTML, LaTeX, RTF, SVG, images, or ANSI terminal sequences.
Install it if you need to display or transform source code.
Six provides utility functions to write Python code that runs on both Python 2.7 and Python 3.3+, smoothing over language differences between the two versions.
See also sphinx-markdown-builder · sphinx-llm · sphinx_mdinclude · atlassian-doc-builder · m2r2 · atlas-doc-parser · Sphinx · sphinxcontrib-htmlhelp · md2cf · sphinxcontrib-qthelp