Documentation engine for YAML.
Project description
Documentation Engine for YAML
This package converts a YAML file into markdown, formatting values and associated metadata in a doxygen
-like way.
Installation
pip install yamldoc
This will install the python package, which contains a command line interface yamldoc
.
Usage
For a basic report, point the command line interface to a YAML file.
yamldoc test/yaml/basic.yaml
You can also include type information from a schema file.
yamldoc test/yaml/basic.yaml -s test/schema/basic.schema
Other Options
yamldoc
defaults to using #'
as a special marker, but you can choose this character yourself if you wish. Just set it on the command line at parse-time:
yamldoc test/yaml/basic.yaml -c "YOURCHAR"
yamldoc
also includes support for certain special declarations in the schema file. Right now these include:
_yamldoc_title
: This specifies the overall title of the markdown page generated._yamldoc_description
: A description to follow the title.
These are picked out of the schema file and reported.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.