papadeltasierra / sphinxcontrib-confluencebuilder

A confluence wiki markup builder plugin for Sphinx

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Atlassian Confluence Builder for Sphinx

pip Version Build Status Documentation Status

Sphinx extension to build Confluence Wiki markup formatted 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:

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

  • Bulleted Lists
  • Citations
  • Code Blocks
  • Definitions
  • Enumerated Lists
  • Footnotes
  • Headings
  • Hyperlinks
  • Indentations
  • Inline Blocks/Literals
  • Paragraphs
  • Tables
  • TOC Tree

About

A confluence wiki markup builder plugin for Sphinx

License:Other


Languages

Language:Python 99.6%Language:HTML 0.1%Language:Smarty 0.1%Language:Java 0.1%Language:C++ 0.1%Language:C 0.1%