This package provides tooling for validating and building Ansible documentation. It mainly consists of a CLI tool, antsibull-docs, and a Sphinx extension. The main output format are reStructured Text (RST) files for consumption by Sphinx.

• Ansible documentation style guide
• antsibull-docs – Ansible Documentation Build Scripts: Creating a collection docsite

There are several different docstring formats which one can use in order to enable Sphinx’s autodoc extension to automatically generate documentation. For this tutorial we will use the Sphinx format, since, as the name suggests, it is the standard format used with Sphinx. Other formats include Google (see here) and NumPy (see here), but they require the use of Sphinx’s napoleon extension, which is beyond the scope of this tutorial.

This project provides a Pygments lexer that is able to handle Ansible output. It may be used anywhere Pygments is integrated. The lexer is registered globally under the name ansible-output.

It also provides a Pygments style for tools needing to highlight code snippets.

The code is licensed under the terms of the BSD 2-Clause license.

This extension allows you to embed Graphviz graphs in your documents.

Markdown is a lightweight markup language with a simplistic plain text formatting syntax. It exists in many syntactically different flavors. To support Markdown-based documentation, Sphinx can use MyST-Parser. MyST-Parser is a Docutils bridge to markdown-it-py, a Python package for parsing the CommonMark Markdown flavor.

Sphinx makes it easy to create intelligent and beautiful documentation.

Here are some of Sphinx’s major features:

• Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text

• Extensive cross-references: semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information

• Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children

• Automatic indices: general index as well as a language-specific module indices

• Code handling: automatic highlighting using the Pygments highlighter

• Extensions: automatic testing of code snippets, inclusion of docstrings from Python modules (API docs) via built-in extensions, and much more functionality via third-party extensions.

• Themes: modify the look and feel of outputs via creating themes, and re-use many third-party themes.

• Contributed extensions: dozens of extensions contributed by users; most of them installable from PyPI.

Sphinx uses the reStructuredText markup language by default, and can read MyST markdown via third-party extensions. Both of these are powerful and straightforward to use, and have functionality for complex documentation and publishing workflows. They both build upon Docutils to parse and write documents.

Atlassian® Confluence® Builder for Sphinx is a community provided extension to help build Confluence supported format files (e.g. storage format) and publish them to a Confluence instance.

License: BSD-2-Clause
Confluence Cloud / Server 7.8+
Python 2.7 or 3.7+
Sphinx 1.8 or 4.1+
The community and development for this extension can all be found at this project's GitHub repository:

Atlassian Confluence Builder for Sphinx - GitHub
https://github.com/sphinx-contrib/confluencebuilder