Skip to main content

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

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

Project details


Release history Release notifications

This version
History Node

1.0.0

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
sphinxcontrib-yaml-1.0.0.tar.gz (3.1 kB) Copy SHA256 hash SHA256 Source None Mar 19, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page