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
- Register the extension
sphinxcontrib.confluencebuilderin the project's configuration script (conf.py):
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.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinxcontrib_confluencebuilder-3.2.0.tar.gz.
File metadata
- Download URL: sphinxcontrib_confluencebuilder-3.2.0.tar.gz
- Upload date:
- Size: 155.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
802d069f09dc27730fad6addcf3e77ee28616c9379b8797fa292e752670cf911
|
|
| MD5 |
3d9ccdeb63c76d4cf3b2a7a7046059b1
|
|
| BLAKE2b-256 |
11c36d7b88f7300d6f66777d83685ab2602c4ed2beef48a2e10bf9fb1a759843
|
Provenance
The following attestation bundles were made for sphinxcontrib_confluencebuilder-3.2.0.tar.gz:
Publisher:
publish-pypi.yml on sphinx-contrib/confluencebuilder
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinxcontrib_confluencebuilder-3.2.0.tar.gz -
Subject digest:
802d069f09dc27730fad6addcf3e77ee28616c9379b8797fa292e752670cf911 - Sigstore transparency entry: 2314726385
- Sigstore integration time:
-
Permalink:
sphinx-contrib/confluencebuilder@b6c533bc8629cdd42eb67dbcc02e7890129306bb -
Branch / Tag:
refs/tags/v3.2 - Owner: https://github.com/sphinx-contrib
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@b6c533bc8629cdd42eb67dbcc02e7890129306bb -
Trigger Event:
push
-
Statement type:
File details
Details for the file sphinxcontrib_confluencebuilder-3.2.0-py3-none-any.whl.
File metadata
- Download URL: sphinxcontrib_confluencebuilder-3.2.0-py3-none-any.whl
- Upload date:
- Size: 250.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9b0f923e6c650466144ea4d76645e6d72731910c9d8bbaff80abaefea203fad1
|
|
| MD5 |
2861f23c197dd2d14d3c0481e4747b90
|
|
| BLAKE2b-256 |
49b3408d7feaf2831bc25b15457a887d99ecd4b61cfc311ec0ae4b1972745ae3
|
Provenance
The following attestation bundles were made for sphinxcontrib_confluencebuilder-3.2.0-py3-none-any.whl:
Publisher:
publish-pypi.yml on sphinx-contrib/confluencebuilder
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinxcontrib_confluencebuilder-3.2.0-py3-none-any.whl -
Subject digest:
9b0f923e6c650466144ea4d76645e6d72731910c9d8bbaff80abaefea203fad1 - Sigstore transparency entry: 2314726428
- Sigstore integration time:
-
Permalink:
sphinx-contrib/confluencebuilder@b6c533bc8629cdd42eb67dbcc02e7890129306bb -
Branch / Tag:
refs/tags/v3.2 - Owner: https://github.com/sphinx-contrib
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@b6c533bc8629cdd42eb67dbcc02e7890129306bb -
Trigger Event:
push
-
Statement type:
