{"library":"sphinxcontrib-confluencebuilder","title":"Sphinx Confluence Builder","type":"library","description":"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.","language":"python","status":"active","last_verified":"Sun May 17","install":{"commands":["pip install sphinxcontrib-confluencebuilder"],"cli":null},"imports":["extensions = ['sphinxcontrib.confluencebuilder'] # in conf.py"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":null,"github":"https://github.com/sphinx-contrib/confluencebuilder","docs":"https://sphinxcontrib-confluencebuilder.readthedocs.io","changelog":null,"pypi":"https://pypi.org/project/sphinxcontrib-confluencebuilder/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"import os\n\n# --- In conf.py ---\n\n# Add 'sphinxcontrib.confluencebuilder' to your extensions list\nextensions = [\n    'sphinxcontrib.confluencebuilder'\n]\n\n# --- Essential Confluence Publishing Configuration ---\n# Ensure these are set to enable publishing to Confluence\nconfluence_publish = True\nconfluence_space_key = os.environ.get('CONFLUENCE_SPACE_KEY', 'MYSPACE') # Use your Confluence space key\nconfluence_parent_page = os.environ.get('CONFLUENCE_PARENT_PAGE', 'MyDocumentation') # Top-level page under which docs will be published\nconfluence_server_url = os.environ.get('CONFLUENCE_SERVER_URL', 'https://example.atlassian.net/wiki/') # Your Confluence URL\nconfluence_server_user = os.environ.get('CONFLUENCE_SERVER_USER', 'myuser@example.com') # Your Confluence username (email for Cloud)\n\n# Using an API token is highly recommended instead of a password.\n# Store securely, e.g., in an environment variable.\n# For Confluence Cloud, use confluence_publish_token for API tokens.\n# For Data Center, confluence_server_pass can be used for password or PAT.\nconfluence_publish_token = os.environ.get('CONFLUENCE_PUBLISH_TOKEN', '')\n\n# Optional: Enable dry run to check what would be published without actually publishing\n# confluence_publish_dryrun = True\n\n\n# --- To build and publish from your project root (after conf.py is setup) ---\n# Run in your terminal:\n# sphinx-build -M confluence . _build -E -a\n# or\n# python -m sphinx -M confluence . _build -E -a","lang":"python","description":"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.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-17","installed_version":"2.15.0","pypi_latest":"3.1.0","is_stale":true,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":5.3,"avg_import_s":null,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"sphinxcontrib-confluencebuilder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"94.3M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"sphinxcontrib-confluencebuilder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5,"import_time_s":null,"mem_mb":null,"disk_size":"95M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"sphinxcontrib-confluencebuilder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"103.9M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"sphinxcontrib-confluencebuilder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.2,"import_time_s":null,"mem_mb":null,"disk_size":"104M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"sphinxcontrib-confluencebuilder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"94.7M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"sphinxcontrib-confluencebuilder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5,"import_time_s":null,"mem_mb":null,"disk_size":"95M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"sphinxcontrib-confluencebuilder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"94.6M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"sphinxcontrib-confluencebuilder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5,"import_time_s":null,"mem_mb":null,"disk_size":"95M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"sphinxcontrib-confluencebuilder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"93.7M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"sphinxcontrib-confluencebuilder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":6.1,"import_time_s":null,"mem_mb":null,"disk_size":"94M"}]}}