Skip to content

chadmv/sphinx-confluence

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sphinx Confluence Plugin

Sphinx extension for making the documentation compatible with the Confluence Storage Format. Read more: https://confluence.atlassian.com/display/DOC/Confluence+Storage+Format

Features:

  • base HTML elements
  • images (image, figure)
  • code blocks (::) and includes (literalinclude)
  • referencing downloadable files (:download:)
  • the TOC tree (.. toctree::)
  • internal links (:ref: <label>; .. _)

Install

pip install sphinx-confluence

Setup with conf.py

Plugin includes to section extensions

sys.path.append('!!!_PATH_TO_EXTENSION_!!!')
extensions = ['confluence']
html_translator_class = 'confluence.HTMLConfluenceTranslator'
html_add_permalinks=''

Build docs with conf.py

Plugin has own Builder json_conf

sphinx-build -b json_conf -d build/doctrees source build/json

Build docs without conf.py

    sphinx-build \
        -b json_conf \
        -d build/doctrees \
        -C \
        -D master_doc=index \
        -D html_add_permalinks= \ 
        -D html_translator_class=sphinx_confluence.HTMLConfluenceTranslator \ 
        -D extensions=sphinx_confluence,sphinx.ext.todo \
        source build/json

About

Atlassian Confluence extension for sphinx

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 67.5%
  • Makefile 32.5%