antsibull-docs-parser

What it is and what it does

antsibull-docs-parser is a Python library that extracts and repackages the Ansible documentation markup processing code from the larger antsibull-docs project. It was separated out to allow other projects to parse Ansible's documentation format without pulling in all of antsibull-docs's transitive dependencies. The library handles the parsing and interpretation of Ansible's custom markup syntax used in its documentation.

The package is production-stable, actively maintained, and supports Python 3.9 through 3.13. It has no runtime dependencies, making it lightweight to integrate. It is primarily intended for developers building tools that need to read or transform Ansible documentation, or for the Ansible project's own tooling ecosystem.

Use it for:

• Parse Ansible module and plugin documentation markup in external tools without depending on the full antsibull-docs stack
• Build documentation generation or transformation pipelines that work with Ansible's native markup format
• Integrate Ansible documentation processing into CI/CD workflows or documentation aggregation systems
• Develop linters or validators for Ansible documentation that need to understand its markup structure

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Python library for parsing and processing Ansible documentation markup, extracted from antsibull-docs to enable reuse without its full dependency chain.

Yes, if you need to parse Ansible documentation markup in a Python project. It is actively maintained, has no runtime dependencies, supports current Python versions, and is production-stable. The copyleft GPL-3.0-or-later license requires that derivative works be licensed compatibly, so verify this aligns with your project's licensing before use.

Install

antsibull-docs-parser on PyPI

pip install antsibull-docs-parser

uv add antsibull-docs-parser

poetry add antsibull-docs-parser

Installing antsibull-docs-parser

Before you install

Low install friction with no runtime dependencies. Actively maintained as of 2025-09-28, with recent commits and production-stable status.

License in practice

Dual-licensed under GPL-3.0-or-later and BSD-2-Clause. The GPL-3.0-or-later component is copyleft, requiring derivative works to be licensed under compatible terms.

Quickstart

pip install antsibull-docs-parser==1.2.2

import antsibull_docs_parser
# Use the library to parse Ansible documentation markup

Requires Python 3.9 or later.

Verify before relying

• What specific Ansible documentation markup syntax this library parses (RST, YAML, or other formats)
• Whether this library is intended for end-user documentation processing or primarily for Ansible project tooling
• Performance characteristics or limits on documentation size/complexity

Package facts

Evidence: antsibull_docs_parser-1.2.2-py3-none-any.whl

Tags

More Markup packages