Skip to content

sphinx-contrib/confluencebuilder

master
Switch branches/tags
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
doc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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

If publishing:

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

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 -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

Configuration

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

extensions = [
    'sphinxcontrib.confluencebuilder',
]
confluence_publish = True
confluence_space_name = '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

Features

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

Atlassian Confluence Builder for Sphinx - Features

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

Atlassian Confluence Builder for Sphinx - 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

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.