Skip to content

sphinx-contrib/confluencebuilder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

90b9ee2 · Feb 19, 2025
Feb 19, 2025
Feb 19, 2025
Dec 12, 2020
Feb 19, 2025
Oct 13, 2024
Feb 16, 2025
Aug 20, 2022
Nov 11, 2024
Aug 20, 2022
Jan 2, 2023
Feb 27, 2024
Feb 19, 2025
Mar 3, 2024
Mar 3, 2024
Mar 3, 2024
Feb 18, 2024
Mar 3, 2024
Aug 21, 2022
Feb 19, 2025
Mar 30, 2024
Nov 15, 2021
Oct 12, 2024
Jan 2, 2023
Mar 3, 2024
Jul 25, 2024
Feb 19, 2025
Jul 8, 2024
Feb 27, 2024
Feb 16, 2025
Feb 19, 2025
Jul 1, 2024

Atlassian Confluence Builder for Sphinx

pip Version Build Status Documentation Status PyPI download month

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

Requirements

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.confluencebuilder in 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.