Registry / crm-productivity / sphinxcontrib-confluencebuilder

sphinxcontrib-confluencebuilder

JSON →
library3.1.0pypypiunverified

Sphinx extension to build Confluence® compatible markup format files and optionally publish them to a Confluence instance. It supports both Confluence Cloud and Data Center deployments. The current version is 3.1.0, with regular updates typically following Sphinx and Confluence API changes.

pip install sphinxcontrib-confluencebuilder
INSTALL
IMPORT
SIG · SPHINXCONTRIB-CONF
S
sphinxcontrib-confluencebuilder
crm-productivitypythonv3.1.0
Install
5.3s avg
Import
Disk
96MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v3.1.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.920 runs
installs and imports cleanly · install 0.0s · import 0.000s · 94.3MB
glibc
py 3.103.920 runs
installs and imports cleanly · install 5.3s · import 0.000s · 95MB
96MB installed
● package 96MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

sphinxcontrib.confluencebuilder
extensions = ['sphinxcontrib.confluencebuilder'] # in conf.py
This library is a Sphinx extension; it is activated by adding its name to the 'extensions' list in your Sphinx project's conf.py, not by a direct Python import statement in application code.

To quickly get started, add `sphinxcontrib.confluencebuilder` to the `extensions` list in your Sphinx project's `conf.py`. Then, configure the essential publishing options, including your Confluence server URL, space key, and authentication credentials (preferably an API token via environment variable). Finally, execute Sphinx with the `confluence` builder to generate and publish your documentation.

import os # --- In conf.py --- # Add 'sphinxcontrib.confluencebuilder' to your extensions list extensions = [ 'sphinxcontrib.confluencebuilder' ] # --- Essential Confluence Publishing Configuration --- # Ensure these are set to enable publishing to Confluence confluence_publish = True confluence_space_key = os.environ.get('CONFLUENCE_SPACE_KEY', 'MYSPACE') # Use your Confluence space key confluence_parent_page = os.environ.get('CONFLUENCE_PARENT_PAGE', 'MyDocumentation') # Top-level page under which docs will be published confluence_server_url = os.environ.get('CONFLUENCE_SERVER_URL', 'https://example.atlassian.net/wiki/') # Your Confluence URL confluence_server_user = os.environ.get('CONFLUENCE_SERVER_USER', 'myuser@example.com') # Your Confluence username (email for Cloud) # Using an API token is highly recommended instead of a password. # Store securely, e.g., in an environment variable. # For Confluence Cloud, use confluence_publish_token for API tokens. # For Data Center, confluence_server_pass can be used for password or PAT. confluence_publish_token = os.environ.get('CONFLUENCE_PUBLISH_TOKEN', '') # Optional: Enable dry run to check what would be published without actually publishing # confluence_publish_dryrun = True # --- To build and publish from your project root (after conf.py is setup) --- # Run in your terminal: # sphinx-build -M confluence . _build -E -a # or # python -m sphinx -M confluence . _build -E -a
Debug
Known issues
breakingThe default editor for Confluence Cloud switched from 'v1' to 'v2' in version 3.0. Users with custom configurations relying on 'v1' might experience rendering issues.
fix
Review Confluence page rendering post-upgrade. If issues occur, adjust content or set `confluence_editor = 'v1'` in `conf.py` if 'v1' is still supported by your Confluence instance and desired.
affects: >=3.0.0
breakingAll deprecated configuration options from 2.x and older versions were completely removed in version 3.0. This includes the `confluence_editor` option being deprecated.
fix
Consult the latest documentation for equivalent or new configuration options. Replace any removed options. For `confluence_editor`, consider if `v2` is acceptable or if `confluence_cloud` and `confluence_publish_token` options provide necessary alternatives for modern Confluence environments.
affects: >=3.0.0
breakingSupport for Python 3.9 was dropped starting with version 2.16 (with v2.15 being the final release to support it).
fix
Upgrade your Python environment to 3.10 or newer to use versions 2.16+ of `sphinxcontrib-confluencebuilder`.
affects: >=2.16.0
deprecatedThe `confluence_asset_force_standalone` option was removed in version 2.15 as assets are now always standalone. Page-specific editor overrides were also deprecated in version 2.14.
fix
Remove `confluence_asset_force_standalone` from your `conf.py` as its behavior is now default. Avoid using page-specific editor overrides and transition to global or builder-specific configurations if possible.
affects: >=2.15.0
gotchaIt is never recommended to store sensitive authentication information (API tokens or raw passwords) directly in a committed repository.
fix
Use environment variables (e.g., `os.environ.get('CONFLUENCE_PUBLISH_TOKEN')`), a secure credential manager, or prompt for credentials at build time (e.g., `confluence_ask_password = True`) to keep secrets out of source control.
affects: All
Upgrade
Version history
3.1.0latest on PyPI · released Apr 3, 2026
Audit
Dependencies
SphinxrequiredRequired for core documentation generation and extension framework.
requestsrequiredUsed for communicating with Confluence REST API during publishing.
PythonrequiredMinimum Python version required.
Agent activity
43 hits · last 30 days
node
40
OpenAI (training)
1
Resources