Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Obsolete - use sphinxcontrib-autoyaml instead

Project Description

This Sphinx autodoc extension documents YAML files from comments. It looks for documentation comment delimeter(default: ###) and adds all further comments as reST documentation till it finds another delimeter or non-comment line.


Options available to use in your configuration:

Look for YAML files relatively to this directory. DEFAULT: ..
Character(s) which start a documentation comment. DEFAULT: ###
Comment start character(s). DEFAULT: #


Some title

Documenting all YAML files from directory recursively.

.. autoyaml:: some_yml_dir

Documenting single YAML file.

.. autoyaml:: some_yml_file.yml

Release History

This version
History Node


Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
(3.1 kB) Copy SHA256 Hash SHA256
Source None Mar 19, 2017

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers