Sphinx extension to build Atlassian Confluence Storage Markup
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Project description
Atlassian Confluence Builder for Sphinx
Sphinx extension to build Confluence® compatible markup format files and optionally publish them to a Confluence instance.
Requirements
- Confluence Cloud or Data Center 7.19+
- Python 3.9+
- Requests 2.25.0+
- Sphinx 7.2+
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 -b confluence . _build/confluence -E -a
(or)
python -m sphinx -b confluence . _build/confluence -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.
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Release history Release notifications | RSS feed
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
Hashes for sphinxcontrib_confluencebuilder-2.8.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | adbafc3bfae8ee9c949df5f754fd5fb1f3c73426a2e813d18599162f495fced5 |
|
| MD5 | 5c64c68b8b468be45ce61873573e9e32 |
|
| BLAKE2b-256 | 82c482369e67dc253b29e279a251b074bf7478f8315f39706b48de8d6866581a |
Hashes for sphinxcontrib_confluencebuilder-2.8.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b11238c3e270a769ebf6975c18ccf0c95af6738e96a64117429f622c0343097a |
|
| MD5 | c6213b98284d7deaa00f3ca50efe3e05 |
|
| BLAKE2b-256 | 39ade4d2ca6d8dbcbc1c65f46ef636e4430cb78a663392be73e2f1408d905441 |
