{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation/2"}],"enrichment":{"capability":"A Sphinx extension that auto-generates documentation for YAML files by extracting and formatting comments as reStructuredText definitions.","skillfed_tags":["yaml-documentation","sphinx-extension","config-docs"],"use_cases":["Generate reference documentation for application configuration files stored in YAML format.","Automatically document infrastructure-as-code YAML files (e.g., Ansible playbooks, Kubernetes configs) from inline comments.","Create self-documenting YAML schemas by extracting structured comments into Sphinx-generated HTML or PDF docs.","Maintain synchronized documentation and YAML configuration by embedding docs as comments in the source files."],"what_it_does":"sphinxcontrib-autoyaml is a Sphinx extension that turns YAML configuration files into readable documentation by extracting comments and converting them to reStructuredText format. It works by scanning YAML files for comments that start with a configurable delimiter (default `###`) and renders each comment as a definition entry paired with its YAML key.\n\nThe extension is designed for documenting configuration files and similar YAML-based settings. It handles nested structures up to a configurable depth and flattens sequences to focus on mapping keys. It depends on Sphinx for documentation generation and ruamel.yaml for YAML parsing. The package has known limitations: complex mapping keys and flow-style entries are only partially documented, and sequences are traversed but not represented in output.","worth_installing":"Yes, if you maintain YAML configuration files and use Sphinx for documentation. The low install friction, permissive license, and straightforward directive syntax make it a practical choice for keeping YAML docs in sync with source. The Alpha status and known limitations (flow-style entries, complex keys) mean you should test it against your specific YAML patterns first."},"id":"sphinxcontrib-autoyaml","links":{"html":"https://skillfed.io/packages/sphinxcontrib-autoyaml","md":"https://skillfed.io/packages/sphinxcontrib-autoyaml.md","pypi":"https://pypi.org/project/sphinxcontrib-autoyaml/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2026-05-25","license_spdx":"MIT","license_treatment":"permissive","name":"sphinxcontrib-autoyaml","python_support":"supports_current","summary":"Sphinx autodoc extension for documenting YAML files from comments"},"popularity":{"monthly_downloads":87520,"position":13793,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"1.2.0"}