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.yml1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file sphinxcontrib-yaml-1.0.0.tar.gz.
File metadata
- Download URL: sphinxcontrib-yaml-1.0.0.tar.gz
- Upload date:
- Size: 3.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e3c2785a9bdb68ff544b3881247258ac66bc7c15a94844afff998ec9ef65efba
|
|
| MD5 |
38d43a8fa6d7a4d11f5f7fd2d4e4ac64
|
|
| BLAKE2b-256 |
964e4748df940f06ebec9f436b71969042974a527118f80ab5f8591b2b93c260
|
