Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Sphinx extension to output Atlassian Confluence Wiki files and publish to Confluence Servers.

Project Description

Sphinx extension to build Confluence Wiki markup formatted files and optionally publish them to a Confluence server.

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

Release History

This version
History Node

0.8

History Node

0.7

History Node

0.6

History Node

0.5.0

History Node

0.4.0

History Node

0.3.0

History Node

0.3.0.dev20170123

History Node

0.2.0dev-20160713

History Node

0.1.1dev-20160712

History Node

0.1dev-20160712

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinxcontrib_confluencebuilder-0.8-py3-none-any.whl (41.6 kB) Copy SHA256 Checksum SHA256 py3 Wheel Dec 6, 2017
sphinxcontrib-confluencebuilder-0.8.tar.gz (24.4 kB) Copy SHA256 Checksum SHA256 Source Dec 6, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting