Skip to main content

Sphinx extension to build Atlassian Confluence Storage Markup

Project description

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

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

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 -M confluence . _build -E -a
 (or)
python -m sphinx -M confluence . _build -E -a

For more information on the usage of this extension, see also:

Atlassian Confluence Builder for Sphinx — Tutorial
https://sphinxcontrib-confluencebuilder.readthedocs.io/tutorial

Configuration

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

extensions = [
    'sphinxcontrib.confluencebuilder',
]
confluence_publish = True
confluence_space_key = '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
https://sphinxcontrib-confluencebuilder.readthedocs.io/configuration

Features

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

Atlassian Confluence Builder for Sphinx — Features
https://sphinxcontrib-confluencebuilder.readthedocs.io/features

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

Atlassian Confluence Builder for Sphinx — Directives
https://sphinxcontrib-confluencebuilder.readthedocs.io/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
https://sphinxcontrib-confluencebuilder.atlassian.net/


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.

Project details


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-2.13.0.tar.gz (148.0 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file sphinxcontrib_confluencebuilder-2.13.0.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib_confluencebuilder-2.13.0.tar.gz
Algorithm Hash digest
SHA256 d929746707479f47577fe91b35cc5a0cc7d62da19d7d480246329300303eba73
MD5 9a714bd786738530b42c9da6175fa46e
BLAKE2b-256 7c01f82dff94acb7fbb6dc96d744cc7ed6a43e15a5714a6c932ca33fbbca9953

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinxcontrib_confluencebuilder-2.13.0.tar.gz:

Publisher: publish-pypi.yml on sphinx-contrib/confluencebuilder

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinxcontrib_confluencebuilder-2.13.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_confluencebuilder-2.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a2dcce32af37110d4c628b30d35be1b215c42fa79411b37e535bc3b327c4e3ae
MD5 0a73bab11bf7023ce076e5f3c2a39229
BLAKE2b-256 d8a2ad3811d673d8e6cee6d59a9b496c67eb140d9395e09014ab74d788bb523e

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinxcontrib_confluencebuilder-2.13.0-py3-none-any.whl:

Publisher: publish-pypi.yml on sphinx-contrib/confluencebuilder

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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