antsibull-docs
Tools for building Ansible documentation
Decision gist · record as of 2026-08-14
Yes, if you are building or maintaining Ansible documentation. The package is actively maintained, has no known vulnerabilities, installs with low friction, and is production-stable. The GPL-3.0-or-later license is appropriate for open-source Ansible projects but requires review for proprietary use. Not recommended for general-purpose documentation building outside the Ansible ecosystem, as it is purpose-built and not designed as a reusable library.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.9 or later.
- The package is intended as a command-line tool and Sphinx extension, not as a library for general use.
- Low friction installation with a pure Python wheel.
License · maintenance · safety
GPL-3.0-or-later (copyleft) — Licensed under GPL-3.0-or-later (copyleft). Any derivative work or distribution must comply with GPL v3 terms, including source disclosure obligations. Suitable for open-source projects but requires careful review for proprietary use.
last release 2026-08-14 (0 days) · last repo commit 2026-08-14 · 40 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 156,871 downloads/mo, #10,773 on PyPI
Alternatives
Verify before relying
pip install antsibull-docs
from antsibull_docs import __version__
print(__version__)
# Or use the command-line tool:
# antsibull-docs --help- Specific Ansible/ansible-core version compatibility requirements beyond what's documented in the changelog
- Whether the Sphinx extension works with all current Sphinx versions or has version constraints
- Performance characteristics when building large documentation sets
What it is and what it does
antsibull-docs is a toolchain for building Ansible project documentation. It provides both a command-line interface (`antsibull-docs`) and a Sphinx extension (`sphinx_antsibull_ext`) that handle the specialized markup and formatting needs of Ansible documentation. The package depends on Sphinx, Jinja2, docutils, and several sister antsibull projects (antsibull-core, antsibull-changelog, antsibull-docs-parser, antsibull-docutils, antsibull-fileutils) to parse, validate, and render Ansible-specific documentation elements.
It is actively maintained and marked as production-stable, supporting Python 3.9 through 3.14. The project explicitly states it is not intended for use as a general library—it is a command-line and Sphinx extension tool for the Ansible documentation ecosystem. The codebase follows semantic versioning from 1.0.0 onward, with the current major version 2.x dropping support for older Python and Ansible versions.
Use it for
- Building official Ansible project documentation using the antsibull-docs command-line tool
- Integrating Ansible documentation generation into a Sphinx-based documentation pipeline via the sphinx_antsibull_ext extension
- Processing and validating Ansible markup and changelog fragments as part of a release workflow
- Generating formatted HTML or other output formats from Ansible source documentation
- Contributing to Ansible community documentation that relies on this toolchain
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you are building or maintaining Ansible documentation.
The package is actively maintained, has no known vulnerabilities, installs with low friction, and is production-stable. The GPL-3.0-or-later license is appropriate for open-source Ansible projects but requires review for proprietary use. Not recommended for general-purpose documentation building outside the Ansible ecosystem, as it is purpose-built and not designed as a reusable library.
Install
antsibull-docs on PyPI
Before you install
Low friction installation with a pure Python wheel. Active maintenance as of 2026-08-14 with no known vulnerabilities. Requires Python 3.9 or later and pulls in 16 runtime dependencies including Sphinx, Jinja2, and other documentation tooling.
Requires Python 3.9 or later. The package is intended as a command-line tool and Sphinx extension, not as a library for general use.
License in practice
Licensed under GPL-3.0-or-later (copyleft). Any derivative work or distribution must comply with GPL v3 terms, including source disclosure obligations. Suitable for open-source projects but requires careful review for proprietary use.
Quickstart
pip install antsibull-docs
from antsibull_docs import __version__
print(__version__)
# Or use the command-line tool:
# antsibull-docs --helpVerify before relying
- Specific Ansible/ansible-core version compatibility requirements beyond what's documented in the changelog
- Whether the Sphinx extension works with all current Sphinx versions or has version constraints
- Performance characteristics when building large documentation sets
Package facts
| License | GPL-3.0-or-later copyleft |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 16 packagesaiohttpansible-pygmentsantsibull-changelogantsibull-coreantsibull-docs-parserantsibull-docutilsantsibull-fileutilsasyncio-pooldocutilsjinja2packagingpydanticpyyamlrstchecksemantic-versionsphinx |
| Maintenance | Actively maintained 0 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 156,871 / month, #10,773 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableFramework :: AnsibleIntended Audience :: DevelopersProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Programming Language :: Python :: 3.9Typing :: Typed |
Evidence: antsibull_docs-2.26.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “ansible documentation builder”
- antsibull-docsBuilds and generates Ansible documentation from source, providing a…
- antsibull-changelogantsibull-changelog is a CLI tool that generates structured…
- ansible-builderAnsible Builder automates the creation of Ansible execution…
Give your agent the search over MCP, or paste the wish link into any chat.
More Sphinx packages
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured information like descriptions, parameters, return types, and exceptions.
Install it if you need to programmatically read and extract structured data from Python docstrings.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
A Sphinx extension that converts documentation source files into QtHelp format, enabling integration with Qt-based help systems and documentation viewers.
However, be aware that maintenance is dormant—if you rely on it long-term, monitor Sphinx compatibility and consider whether QtHelp remains the right format for your…
See also antsibull-changelog · antsibull-core · antsibull-docs-parser · antsibull-docutils · antsibull-fileutils · ansible-creator · ansible-pygments · ansible · linuxdoc · sphinx-multiversion