https://github.com/sphinx-contrib/confluencebuilder
Confluence Markup Builder Plugin for Sphinx
https://github.com/sphinx-contrib/confluencebuilder
documentation python sphinx sphinx-extension
Last synced: 29 days ago
JSON representation
Confluence Markup Builder Plugin for Sphinx
- Host: GitHub
- URL: https://github.com/sphinx-contrib/confluencebuilder
- Owner: sphinx-contrib
- License: bsd-2-clause
- Created: 2016-07-07T01:20:41.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2025-03-16T21:33:05.000Z (about 2 months ago)
- Last Synced: 2025-04-04T08:54:12.842Z (about 1 month ago)
- Topics: documentation, python, sphinx, sphinx-extension
- Language: Python
- Homepage:
- Size: 5.41 MB
- Stars: 331
- Watchers: 12
- Forks: 97
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Support: support/docker/Dockerfile
- Authors: AUTHORS
Awesome Lists containing this project
README
# Atlassian Confluence Builder for Sphinx
[](https://pypi.python.org/pypi/sphinxcontrib-confluencebuilder)
[](https://github.com/sphinx-contrib/confluencebuilder/actions/workflows/build.yml)
[](https://sphinxcontrib-confluencebuilder.readthedocs.io/)
[](https://pypi.python.org/pypi/sphinxcontrib-confluencebuilder/)
[Sphinx][sphinx] extension to build Confluence® compatible markup format
files and optionally publish them to a Confluence instance.
## Requirements
* [Confluence][confluence] Cloud or Data Center 8.1+
* [Python][python] 3.9+
* [Requests][requests] 2.25.0+
* [Sphinx][sphinx] 7.3+
## Installing
The recommended method to installing this extension is using [pip][pip]:
```shell
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.confluencebuilder` in the project's
configuration script (`conf.py`):
```python
extensions = [
'sphinxcontrib.confluencebuilder',
]
```
- Run sphinx-build with the builder `confluence`:
```shell
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:
```python
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.
[confluence]: https://www.atlassian.com/software/confluence
[pip]: https://pip.pypa.io/
[python]: https://www.python.org/
[requests]: https://pypi.python.org/pypi/requests
[sphinx]: https://www.sphinx-doc.org/