Sphinx extension to output Atlassian Confluence Storage Markup documents and publish to Confluence instances.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for anthonypjshaw from gravatar.com anthonypjshaw Avatar for jdknight from gravatar.com jdknight

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

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
 (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/en/latest/install.html

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
https://sphinxcontrib-confluencebuilder.readthedocs.io/en/latest/tutorial.html

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_server_user = 'username'
confluence_server_pass = 'api-key-or-password'

For a complete list of configuration options, see also:

Atlassian Confluence Builder for Sphinx - Configuration
https://sphinxcontrib-confluencebuilder.readthedocs.io/en/latest/configuration.html

Directives

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

Atlassian Confluence Builder for Sphinx - Directives
https://sphinxcontrib-confluencebuilder.readthedocs.io/en/latest/directives.html

Demonstration

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

Atlassian Confluence Builder for Sphinx - Validation Set
https://github.com/sphinx-contrib/confluencebuilder/tree/master/test/validation-sets

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

Atlassian Confluence Builder for Sphinx - Online Demo on Confluence Cloud
https://jdknight.atlassian.net/wiki/spaces/confluencebuilder/

Supported Markup

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

Atlassian Confluence Builder for Sphinx - Markup
https://sphinxcontrib-confluencebuilder.readthedocs.io/en/latest/markup.html

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for anthonypjshaw from gravatar.com anthonypjshaw Avatar for jdknight from gravatar.com jdknight

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

2.9.0

2.8.0

2.7.1

2.7.0

2.6.1

2.6.0

2.5.2

2.5.1

2.5.0

2.4.0

2.3.0

2.2.0

2.1.1

2.1.0

2.0.0

1.9.0

1.8.0

1.7.1

1.7.0

1.6.0

1.5.0

1.4.0

1.3.0

This version

1.2.0

1.1.0

1.0.0

0.9

0.8

0.7

0.6

0.5.0

0.4.0

0.3.0

0.3.0.dev20170123 pre-release

0.2.0dev-20160713 pre-release

0.1.1dev-20160712 pre-release

0.1dev-20160712 pre-release

Download files

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

Source Distribution

sphinxcontrib-confluencebuilder-1.2.0.tar.gz (54.3 kB view hashes)

Uploaded Source

Built Distribution

sphinxcontrib_confluencebuilder-1.2.0-py2.py3-none-any.whl (56.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page