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
Metadata
1 maintainer
Release files for sphinxcontrib-yaml 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxcontrib-yaml-1.0.0.tar.gz | 3.1 kB | Details |
Release files / sphinxcontrib-yaml-1.0.0.tar.gz
| Download URL | sphinxcontrib-yaml-1.0.0.tar.gz |
|---|---|
| Size | 3.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e3c2785a9bdb68ff544b3881247258ac66bc7c15a94844afff998ec9ef65efba
|
|
BLAKE2b-256 checksum How to use checksums |
964e4748df940f06ebec9f436b71969042974a527118f80ab5f8591b2b93c260
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
