{"id":20930,"library":"antsibull-docs","title":"antsibull-docs","description":"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.","status":"active","version":"2.24.0","language":"python","source_language":"en","source_url":"https://github.com/ansible-community/antsibull-docs","tags":["ansible","documentation","docs","collection"],"install":[{"cmd":"pip install antsibull-docs","lang":"bash","label":"Standard install"}],"dependencies":[{"reason":"Core utilities for antsibull-docs; often installed together","package":"antsibull-core","optional":false},{"reason":"Async I/O helpers","package":"asyncio-helper","optional":false},{"reason":"For building docsites","package":"sphinx","optional":true}],"imports":[{"wrong":"from antsibull_docs.cli import AnsibleDocsCli","symbol":"annotations","correct":"from antsibull_docs import annotations"}],"quickstart":{"code":"from antsibull_docs.cli import AnsibleDocsCli\ncli = AnsibleDocsCli()\n# Run the CLI; for example, to generate collection docs:\n# cli.run(['collection', '--help'])","lang":"python","description":"Minimal usage: import and instantiate the CLI. For actual doc generation, invoke with subcommands like 'collection' or 'manpage'."},"warnings":[{"fix":"Migrate to the new CLI; see https://github.com/ansible-community/antsibull-docs/blob/main/CHANGELOG.rst for details.","message":"antsibull-docs v2 reworked the CLI and configuration. Scripts using the old v1 CLI flags or import paths will break.","severity":"breaking","affected_versions":">=1.0,<2.0 -> 2.x"},{"fix":"Use the new output format; remove the flag.","message":"The 'antsibull-docs collection' subcommand's '--use-classic-output' option is deprecated in v2.16+ and will be removed.","severity":"deprecated","affected_versions":">=2.16,<3.0"},{"fix":"Install the collections you intend to document (e.g., via ansible-galaxy) and set ANSIBLE_COLLECTIONS_PATH or use the --collection-dir flag.","message":"Running antsibull-docs from a virtualenv without required Ansible collections installed will cause runtime errors. docs-build expects collections under a specific path.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"search_vec":"'-4':30 '2':29 '2.24.0':18 '3.9':20 'ad':25 'ad-hoc':24 'ansibl':7,32 'antsibul':2 'antsibull-doc':1 'build':6 'cadenc':23 'collect':10,35 'current':16 'doc':3,11,34 'docsit':15 'document':8,33 'everi':28 'hoc':26 'includ':9 'man':12 'month':31 'page':13 'python':19 'releas':22 'requir':21 'rough':27 'tool':4 'version':17","created_at":"2026-04-27T16:57:10.835038+00:00","updated_at":"2026-04-27T16:57:10.835038+00:00","problems":null,"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":"2.24.0","cli_name":"antsibull-docs","cli_version":"2.24.0","type":"library","homepage":null,"github":"https://github.com/ansible-community/antsibull-docs","docs":"https://docs.ansible.com/projects/antsibull-docs/","changelog":"https://github.com/ansible-community/antsibull-docs/tree/main/CHANGELOG.md","pypi":"https://pypi.org/project/antsibull-docs/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["devops"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"passing","verified_at":"2026-06-30","last_verified":"2026-06-30","next_check":"2026-07-30","install_tag":null}}