Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

A Simple Tool for Documenting YAML Files

Project description

Author: Hartmut Goebel <h.goebel@crazy-compilers.com>
Copyright: 2015 by Hartmut Goebel
Licence:GNU General Public Licence v3 or later (GPLv3+)

This tool allows you writing documentation directly into YAML-files as comments. These comments will then be converted to text and the YAML-code goes into literal blocks.

This is some kind of literate programming, except that you do not write code into your text, but text into your code. This difference allows to process the YAML file directly without any pre-processing.

Usage:

yaml2rst [-h] infile outfile

positional arguments:
  infile      YAML-file to read (`-` for stdin)
  outfile     rst-file to write (`-` for stdout)

optional arguments:
  -h, --help  show this help message and exit

How it works

This script takes all lines beginning with # (and lines consisting of only a #) as text-lines. Everything else will be treated as “code”. The text-lines will get the # removed and the “code” will get spaces prepended.

Additionally at the start and at the end of a “code”-block, lines are added as required by reStructuredText. Also at the begin of a “code”-block, a :: is added if required.

Examples

You can find example yaml-input, rst-output and generated html in the examples directory. You may also view the generated html online at https://rawgit.com/htgoebel/yaml2rst/develop/examples/main.html.

Project details


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
yaml2rst-0.2.tar.gz (22.0 kB) Copy SHA256 hash SHA256 Source None Feb 21, 2015

Supported by

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