antsibull-docs

library2.24.0pypypi✓ verified 83d ago

Tools for building Ansible documentation, including collection docs, man pages, and docsite. Current version 2.24.0, Python >=3.9 required. Release cadence: ad-hoc, roughly every 2-4 months.

devops

pip install antsibull-docs

github ↗package ↗docs ↗changelog ↗

INSTALL

IMPORT

SIG · ANTSIBULL-DOCS

antsibull-docs

devopspythonv2.24.0

Install

12.1s avg

Import

—

Disk

128MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v2.24.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 122.8MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 12.1s · import 0.000s · 125MB

128MB installed

● package 128MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

annotations

✓ from antsibull_docs import annotations

✗ from antsibull_docs.cli import AnsibleDocsCli

Minimal usage: import and instantiate the CLI. For actual doc generation, invoke with subcommands like 'collection' or 'manpage'.

from antsibull_docs.cli import AnsibleDocsCli cli = AnsibleDocsCli() # Run the CLI; for example, to generate collection docs: # cli.run(['collection', '--help'])

antsibull-docs --version

Debug

Known issues

breakingantsibull-docs v2 reworked the CLI and configuration. Scripts using the old v1 CLI flags or import paths will break.

fix

Migrate to the new CLI; see https://github.com/ansible-community/antsibull-docs/blob/main/CHANGELOG.rst for details.

affects: >=1.0,<2.0 -> 2.x

deprecatedThe 'antsibull-docs collection' subcommand's '--use-classic-output' option is deprecated in v2.16+ and will be removed.

fix

Use the new output format; remove the flag.

affects: >=2.16,<3.0

gotchaRunning antsibull-docs from a virtualenv without required Ansible collections installed will cause runtime errors. docs-build expects collections under a specific path.

fix

Install the collections you intend to document (e.g., via ansible-galaxy) and set ANSIBLE_COLLECTIONS_PATH or use the --collection-dir flag.

affects: all

Upgrade

Version history

2.24.0latest on PyPI · released Dec 24, 2025

Audit

Dependencies

antsibull-corerequiredCore utilities for antsibull-docs; often installed together

asyncio-helperrequiredAsync I/O helpers

sphinxoptionalFor building docsites

Agent activity

22 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/ansible-community/antsibull-docs ↗

packagehttps://pypi.org/project/antsibull-docs/ ↗

docshttps://docs.ansible.com/projects/antsibull-docs/ ↗

changeloghttps://github.com/ansible-community/antsibull-docs/tree/main/CHANGELOG.md ↗