Skip to content
A confluence wiki markup builder plugin for Sphinx
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
sphinxcontrib
test
.gitignore .gitignore: remove unused file Mar 30, 2018
.travis.yml .travis.yml: add new tox environments Mar 7, 2019
AUTHORS
CHANGES.rst update version' Mar 14, 2019
CONTRIBUTING.rst
LICENSE
MANIFEST.in
README.rst
requirements_dev.txt tox: increase test coverage on python and sphinx versions Mar 7, 2019
setup.cfg sphinxcontrib-confluencebuilder 1.2.0-dev0 Mar 17, 2019
setup.py sphinxcontrib-confluencebuilder 1.2.0-dev0 Mar 17, 2019
tox.ini tox: increase test coverage on python and sphinx versions Mar 7, 2019

README.rst

Atlassian Confluence Builder for Sphinx

pip Version Build Status Documentation Status PyPI download month

Sphinx extension to build Confluence storage 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

For a more in-depth installation information, see also:

Atlassian Confluence Builder for Sphinx - Installation

Usage

  • Set the builder sphinxcontrib.confluencebuilder in the as an extension in 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 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_server_user = 'username'
confluence_server_pass = 'password'

For a complete list of configuration changes, see also:

Atlassian Confluence Builder for Sphinx - Configuration

Demonstration

The set of example documents used to assist in validation/testing can be found here:

Atlassian Confluence Builder for Sphinx - Validation Set

The active and older versions of published validation documents can be found here:

Atlassian Confluence Builder for Sphinx - Online Demo on Confluence Cloud

Supported Markup

For a complete list of supported markup, consult the following:

Atlassian Confluence Builder for Sphinx - Markup
You can’t perform that action at this time.