Atlassian Confluence Builder for Sphinx

Sphinx (GitHub) extension to build Confluence® compatible markup format files and optionally publish them to a Confluence instance.

Requirements

Confluence Cloud or Data Center 9.1+
Python 3.10+
Requests 2.30.0+
Sphinx 8.0+

Installing

The recommended method to installing this extension is using pip:

pip install sphinxcontrib-confluencebuilder
 (or)
python -m pip install sphinxcontrib-confluencebuilder

For a more in-depth installation information, see also:

Atlassian Confluence Builder for Sphinx — Installation
https://sphinxcontrib-confluencebuilder.readthedocs.io/install

Usage

extensions = [
    'sphinxcontrib.confluencebuilder',
]

Run sphinx-build with the builder confluence:

sphinx-build -M confluence . _build -E -a
 (or)
python -m sphinx -M confluence . _build -E -a

For more information on the usage of this extension, see also:

Atlassian Confluence Builder for Sphinx — Tutorial
https://sphinxcontrib-confluencebuilder.readthedocs.io/tutorial

Configuration

The following is an example of a simple configuration for Confluence generation and publishing:

extensions = [
    'sphinxcontrib.confluencebuilder',
]
confluence_publish = True
confluence_space_key = 'TEST'
confluence_parent_page = 'Documentation'
confluence_server_url = 'https://intranet-wiki.example.com/'
confluence_ask_user = True
confluence_ask_password = True

For a complete list of configuration options, see also:

Atlassian Confluence Builder for Sphinx — Configuration
https://sphinxcontrib-confluencebuilder.readthedocs.io/configuration

Features

For a complete list of supported markup, extensions, etc.; see:

Atlassian Confluence Builder for Sphinx — Features
https://sphinxcontrib-confluencebuilder.readthedocs.io/features

For a complete list of directives supported by this extension, see:

Atlassian Confluence Builder for Sphinx — Directives
https://sphinxcontrib-confluencebuilder.readthedocs.io/directives

Demonstration

A demonstration of this extension can be seen by inspecting the published validation/testing documents found here:

Atlassian Confluence Builder for Sphinx — Online Demo on Confluence Cloud
https://sphinxcontrib-confluencebuilder.atlassian.net/

Atlassian Confluence Builder for Sphinx project is unaffiliated with Atlassian.
Atlassian is a registered trademark of Atlassian Pty Ltd.
Confluence is a registered trademark of Atlassian Pty Ltd.

Release files for sphinxcontrib-confluencebuilder 3.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinxcontrib-confluencebuilder 3.2.0
File	Size	Uploaded
sphinxcontrib_confluencebuilder-3.2.0.tar.gz	155.9 kB	Aug 1, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinxcontrib-confluencebuilder 3.2.0
File	Interpreter	ABI	Platform	Reset
sphinxcontrib_confluencebuilder-3.2.0-py3-none-any.whl 250.5 kB Aug 1, 2026	Python 3	none	any	Details

Total release size: 406.4 kB

Release files / sphinxcontrib_confluencebuilder-3.2.0.tar.gz

Download URL	sphinxcontrib_confluencebuilder-3.2.0.tar.gz
Size	155.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`802d069f09dc27730fad6addcf3e77ee28616c9379b8797fa292e752670cf911`
BLAKE2b-256 checksum How to use checksums	`11c36d7b88f7300d6f66777d83685ab2602c4ed2beef48a2e10bf9fb1a759843`
Upload date	Aug 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/sphinx-contrib/confluencebuilder
Publishing commit: github.com/sphinx-contrib/confluencebuilder/tree/b6c533bc8629cdd42eb67dbcc02e7890129306bb

Workflow

Publishing configuration: github.com/sphinx-contrib/confluencebuilder/blob/b6c533bc8629cdd42eb67dbcc02e7890129306bb/.github/workflows/publish-pypi.yml
Publishing logs: github.com/sphinx-contrib/confluencebuilder/actions/runs/30718996428/attempts/1

Artifact

Subject: sphinxcontrib_confluencebuilder-3.2.0.tar.gz
SHA-256 checksum: 802d069f09dc27730fad6addcf3e77ee28616c9379b8797fa292e752670cf911 Verifying attestations

Release files / sphinxcontrib_confluencebuilder-3.2.0-py3-none-any.whl

Download URL	sphinxcontrib_confluencebuilder-3.2.0-py3-none-any.whl
Size	250.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`9b0f923e6c650466144ea4d76645e6d72731910c9d8bbaff80abaefea203fad1`
BLAKE2b-256 checksum How to use checksums	`49b3408d7feaf2831bc25b15457a887d99ecd4b61cfc311ec0ae4b1972745ae3`
Upload date	Aug 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/sphinx-contrib/confluencebuilder
Publishing commit: github.com/sphinx-contrib/confluencebuilder/tree/b6c533bc8629cdd42eb67dbcc02e7890129306bb

Workflow

Publishing configuration: github.com/sphinx-contrib/confluencebuilder/blob/b6c533bc8629cdd42eb67dbcc02e7890129306bb/.github/workflows/publish-pypi.yml
Publishing logs: github.com/sphinx-contrib/confluencebuilder/actions/runs/30718996428/attempts/1

Artifact

Subject: sphinxcontrib_confluencebuilder-3.2.0-py3-none-any.whl
SHA-256 checksum: 9b0f923e6c650466144ea4d76645e6d72731910c9d8bbaff80abaefea203fad1 Verifying attestations