antsibull-docutils

What it is and what it does

antsibull-docutils is a Python library that provides helper functions and utilities built on top of docutils, designed to support the Antsibull toolchain used by the Ansible project. It extends docutils' capabilities for processing reStructuredText and generating documentation in formats like HTML and Markdown, with specific optimizations for Ansible's documentation needs.

The library is actively maintained and tested against docutils 0.18 and later. It requires Python 3.9 or higher and has a single runtime dependency on docutils itself, making installation straightforward. The package is part of the Ansible community ecosystem and follows the Ansible Code of Conduct.

Use it for:

• Building Ansible documentation pipelines that need custom docutils processing beyond standard reStructuredText rendering.
• Extending Antsibull tools with specialized docutils functionality for Ansible module and plugin documentation generation.
• Processing reStructuredText with Ansible-specific conventions and formatting requirements in documentation workflows.
• Integrating docutils helpers into CI/CD pipelines that generate Ansible documentation artifacts.

Worth the install?

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

Provides docutils helpers and utilities for Antsibull tools, extending docutils functionality for documentation processing within the Ansible ecosystem.

Yes, if you are building or extending Antsibull tools or Ansible documentation pipelines. The library has low install friction, active maintenance, and no known vulnerabilities. However, if you are not working within the Ansible ecosystem or using Antsibull, this library offers little direct value—it is a specialized utility for a specific toolchain. The GPL-3.0-or-later license requires attention if integrating into proprietary software.

Install

antsibull-docutils on PyPI

pip install antsibull-docutils

uv add antsibull-docutils

poetry add antsibull-docutils

Installing antsibull-docutils

Before you install

Low install friction with a single runtime dependency (docutils). Actively maintained with recent commits; tested against docutils 0.18+. Note that docutils 0.16 and 0.17 are not fully compatible due to different ID and HTML generation for tables.

License in practice

Licensed under GPL-3.0-or-later (copyleft). Use is permitted in open-source projects aligned with GPL terms; proprietary software integration requires careful licensing review or relicensing.

Quickstart

pip install antsibull-docutils

from antsibull_docutils import some_helper
# Use docutils helpers provided by the library

Requires Python 3.9 or later; docutils 0.18+ recommended for full compatibility.

Verify before relying

• Specific docutils helper functions and their use cases are not detailed in the excerpt.
• Whether this library is intended for end-user direct use or primarily as a build-time dependency for Antsibull tools.

Package facts

Evidence: antsibull_docutils-1.4.0-py3-none-any.whl

Tags

More Documentation packages