sphinx-contrib/confluencebuilder sphinx-contrib/confluencebuilder

  • Stars
    star
    312
  • Rank 134,133 (Top 3 %)
  • Language
    Python
  • License
    BSD 2-Clause "Sim...
  • Created over 8 years ago
  • Updated 3 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
sphinx-contrib/confluencebuilder
github

sphinx-contrib

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Confluence Markup Builder Plugin for Sphinx

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

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

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_ask_user = True
confluence_ask_password = True

For a complete list of configuration options, see also:

Atlassian Confluence Builder for Sphinx - Configuration

Features

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

Atlassian Confluence Builder for Sphinx - Features

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

Atlassian Confluence Builder for Sphinx - 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
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.

More Repositories

1

napoleon

Python
149
star
2

sphinxcontrib-versioning

Sphinx extension that allows building versioned docs for self-hosting.
Python
125
star
3

openapi

OpenAPI (fka Swagger) spec renderer for Sphinx.
Python
109
star
4

plantuml

Python
108
star
5

spelling

A spelling checker for Sphinx-based documentation
Python
81
star
6

sphinx-lint

Check for stylistic and formal issues in .rst and .py files included in the documentation
Python
68
star
7

matlabdomain

A Sphinx extension for documenting Matlab code
Python
61
star
8

httpdomain

Documenting RESTful HTTP APIs
Python
59
star
9

apidoc

A Sphinx extension for running sphinx-apidoc on each build
Python
53
star
10

youtube

A Sphinx extension to embed videos from YouTube
Python
51
star
11

emojicodes

An extension to use emoji codes in your Sphinx documentation! ๐Ÿ˜
Python
48
star
12

video

A sphinx plugin that enables embedding of HTML5 videos
Python
45
star
13

autoprogram

Documenting CLI programs
Python
44
star
14

datatemplates

Sphinx plugin for generating RST on the fly from data files and templates.
Python
44
star
15

fulltoc

Extension for Sphinx to make the sidebar show a full table of contents instead of just the local headings
Python
38
star
16

kroki

Embed PlantUML, DOT, etc. diagrams in your documentation using Kroki.
Python
36
star
17

redoc

ReDoc powered OpenAPI (fka Swagger) spec renderer for Sphinx.
Python
33
star
18

restbuilder

A Sphinx builder/writer to output reStructuredText (rst) files
Python
31
star
19

cookiecutter

A cookiecutter template for a Sphinx extension
Python
24
star
20

sphinx-pretty-searchresults

Sphinx: pretty search results is an extension for the Sphinx documentation tool. To display search results, Sphinx is fetching the source files of search hits and rendering excerpts in raw markup. This extension removes the markup from these source files (during build time), so the search results look decent.
Python
22
star
21

googleanalytics

Python
18
star
22

sphinxcontrib-towncrier

An RST directive for injecting a Towncrier-generated changelog draft containing fragments for the unreleased (next) project version. Demo: https://ansible-pylibssh.rtfd.io/changelog. Docs: https://sphinxcontrib-towncrier.rtfd.io
Python
17
star
23

tikz

A Sphinx extension to draw pictures with the TikZ/PGF LaTeX package
Python
16
star
24

doxylink

A Sphinx extension to link to external Doxygen API documentation.
Python
15
star
25

prefectviz

An extension to add Prefect flow visualizations into you Sphinx documentation.
Python
14
star
26

github-administration

This repository is used for managing the sphinx-contrib GitHub organization, including requesting importing new repositories or granting permissions.
13
star
27

svgbob

A Sphinx extension to convert ASCII diagrams to SVGs with Svgbob.
Python
12
star
28

jquery

Extension to include jQuery on newer Sphinx releases
Python
10
star
29

redirects

A Sphinx extension for generating JavaScript-driven redirects for moved pages
Python
9
star
30

typer

Auto generate docs for typer and click commands using typer's rich console formatting.
Python
9
star
31

sqltable

Python
7
star
32

scm

Sphinx SCM interface
Python
7
star
33

email

Python
6
star
34

sphinxcontrib-details-directive

Python
5
star
35

slide

A Sphinx extension to embed presentation slides on Slideshare and other sites
Python
5
star
36

prefecttask

An extension to autodoc Prefect Tasks
Python
5
star
37

icon

custom sphinx role to embed inline icons
Python
5
star
38

sadisplay

A Sphinx extension for displaying SqlAlchemy model
Python
5
star
39

prettyspecialmethods

Shows special/magic methods in sphinx docs as the python syntax that invokes them
Python
5
star
40

pecanwsme

Extension to Sphinx for documenting APIs built with Pecan and WSME
Python
5
star
41

ogp

Sphinx OGP feature for html builder
Python
4
star
42

examplecode

Python
4
star
43

proof

โˆŽ A Sphinx extension to provide directives to typeset theorems, properties, proofs, etc.
Python
4
star
44

exceltable

Python
4
star
45

documentedlist

DocumentedList Sphinx Extension
Python
4
star
46

stuffcounter

A sphinx extension to illustrate the `add_enumerable_node()` method.
Python
4
star
47

cheader

Sphinx extension that implements a c:header directive.
Python
4
star
48

inlinesyntaxhighlight

Python
3
star
49

mscgen

Python
2
star
50

sqlalchemyviz

SqlAlchemyViz Sphinx Extension
Python
2
star
51

feed

Python
2
star
52

cmakedomain

Python
2
star
53

gherkin

Sphinx parser for Gherkin BDD
Shell
2
star
54

googlechart

Python
2
star
55

ansi

๐Ÿ’– Project is looking for extra maintainers, check issue tracker.
Python
2
star
56

requirements

A Sphinx extension that lets you declare requirements wherever you need (e.g. in test docstrings), mark statuses and collect them in a single list
Python
2
star
57

sdedit

A Sphinx extension for inserting sequence diagram by using Quick Sequence Diagram Editor
Python
2
star
58

sword

A Sphinx extension for inserting Bible verses from Sword
Python
2
star
59

autofile

A sphinx extension to generate module for many files from a glob expression. maintainers: @Freed-Wu
Python
2
star
60

packages

๐Ÿ“ฆ Provide directives to display packages installed on the host machine.
Python
2
star
61

findanything

JavaScript
1
star
62

cheeseshop

Python
1
star
63

gnuplot

Python
1
star
64

autoanysrc

Python
1
star
65

gravizo

Embed PlantUML, DOT, etc. diagrams in your documentation using Gravizo.
Python
1
star
66

eval

Evaluate shell command or python code in sphinx and myst.
Python
1
star
67

lilypond

Python
1
star
68

clearquest

Python
1
star
69

whooshindex

A Sphinx whoosh indexer extension
Python
1
star
70

imagesvg

Python
1
star
71

aafig

Sphinx extension to add ASCII-art diagrams using aafigure
Python
1
star
72

zopeext

A Sphinx extension that provides an 'autointerface' directive for using Zope interfaces
Python
1
star
73

cacoo

Python
1
star
74

googlemaps

Python
1
star
75

autorun

Python
1
star
76

rubydomain

A Sphinx extension for Ruby support (Sphinx 1.0 needed)
Python
1
star
77

domaintools

Python
1
star
78

btn

A sphinx custom role to embed inline btn
Python
1
star
79

sphinxcontrib-skeleton

The automatic build of the @sphinx-contrib/copier-sphinxcontrib template
Python
1
star
80

copier-sphinxcontrib

The skeleton of a sphinxcontrib extention
Jinja
1
star
81

sphinxcontrib-termynal

Sphinx extension to include termynal windows in html documentation build.
Python
1
star