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

Sphinx autodoc extension to generate docs from YAML comments

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

Options available to use in your configuration:

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

Example

Some title
==========

Documenting all YAML files from directory recursively.

.. autoyaml:: some_yml_dir

Documenting single YAML file.

.. autoyaml:: some_yml_file.yml
Release History

Release History

This version
History Node

1.0.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinxcontrib-yaml-1.0.0.tar.gz (3.1 kB) Copy SHA256 Checksum SHA256 Source Mar 19, 2017

Supported By

WebFaction WebFaction Technical Writing 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 Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting