{ "info": { "author": "Hartmut Goebel", "author_email": "h.goebel@crazy-compilers.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: System Administrators", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Topic :: Software Development :: Documentation" ], "description": "==========================\nyaml2rst\n==========================\n--------------------------------------------------------------------------\nA Simple Tool and Python-Module for Documenting YAML Files\n--------------------------------------------------------------------------\n\n:Author: Hartmut Goebel \n:Copyright: 2015-2019 by Hartmut Goebel\n:Licence: GNU General Public Licence v3 or later (GPLv3+)\n\n\nThis tool allows you writing documentation directly into YAML-files as\ncomments. These comments will then be converted to text and the YAML-code\ngoes into literal blocks.\n\nThis is some kind of `literate programming`, except that you do not\nwrite code into your text, but text into your code. This difference\nallows to process the YAML file directly without any pre-processing.\n\n\nUsage::\n\n yaml2rst [-h] [--strip-regex regex] infile outfile\n\n positional arguments:\n infile YAML-file to read (`-` for stdin)\n outfile rst-file to write (`-` for stdout)\n\n optional arguments:\n -h, --help show this help message and exit\n --strip-regex regex Regex which will remove everything it matches. Can be\n used to remove fold markers from headings for example.\n Example to strip out [[[,]]] fold markers:\n '\\s*(:?\\[{3}|\\]{3})\\d?$'. Check the README for more\n details.\n\n\nHow it works\n----------------\n\nThis script takes all lines beginning with :literal:`#\\ ` (and lines\nconsisting of only a ``#``) as text-lines. Everything else will be\ntreated as \"code\". The text-lines will get the :literal:`#\\ ` removed\nand the \"code\" will get spaces prepended.\n\nAdditionally at the start and at the end of a \"code\"-block, lines are\nadded as required by reStructuredText. Also at the begin of a\n\"code\"-block, a ``::`` is added if required.\n\n``--strip-regex`` can be used to remove matching characters from text-lines\nwhen needed. Refer to documentation about\n`Folding marks support `_ for details.\n\n\nExamples\n-------------\n\nYou can find example yaml-input, rst-output and generated html in the\nexamples directory. You may also view the generated html online at\nhttps://rawgit.com/debops/yaml2rst/develop/examples/main.html.\n\n\nRelated Tools\n---------------------\n\n* `yaml4rst `_ is a\n linting/checking/reformatting tool for YAML files documented with\n inline RST which goes hand in hand with yaml2rst.\n\n\nMaintainers\n---------------------\n\n`yaml2rst` was originally developed 2015 and maintained by Hartmut\nGoebel. In 2019 the project moved to the `debops` project for which\n`yaml2rst` was developed.\n\n\n..\n Local Variables:\n mode: rst\n ispell-local-dictionary: \"american\"\n End:\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/debops/yaml2rst/releases", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/debops/yaml2rst", "keywords": "YML,YAML,rst,reStructuresText,literate programming", "license": "GPLv3+", "maintainer": "", "maintainer_email": "", "name": "yaml2rst", "package_url": "https://pypi.org/project/yaml2rst/", "platform": "", "project_url": "https://pypi.org/project/yaml2rst/", "project_urls": { "Download": "https://github.com/debops/yaml2rst/releases", "Homepage": "https://github.com/debops/yaml2rst" }, "release_url": "https://pypi.org/project/yaml2rst/0.3/", "requires_dist": null, "requires_python": "", "summary": "A Simple Tool for Documenting YAML Files", "version": "0.3" }, "last_serial": 5505945, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "9b8a4e636503e4129dfae0ed84ab10c3", "sha256": "e6280bd81284f9cc241b127142029a8b7001eac0fde65b18dce01fac692d4ffe" }, "downloads": -1, "filename": "yaml2rst-0.1.zip", "has_sig": false, "md5_digest": "9b8a4e636503e4129dfae0ed84ab10c3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26135, "upload_time": "2015-02-13T10:28:56", "url": "https://files.pythonhosted.org/packages/5d/c9/89ee56f3d12ee1ed73c95ee1b935f408078cc7bba84614b27e81204dbda0/yaml2rst-0.1.zip" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "e6b0c56f71c337f905ab173b5f64474a", "sha256": "57ac0291004d9b31788b77152d9c6c618ab2ba9a9cc1547d148333d0a35a3129" }, "downloads": -1, "filename": "yaml2rst-0.2.tar.gz", "has_sig": false, "md5_digest": "e6b0c56f71c337f905ab173b5f64474a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22011, "upload_time": "2015-02-21T14:41:22", "url": "https://files.pythonhosted.org/packages/7e/66/cc41dc3ca79f09d43a7febc8a6fdef5a6a0249fbe40a0ffd8ee3ad8d4e0b/yaml2rst-0.2.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "3049d5ff40f229563bd59c97ba223f14", "sha256": "e563869fb1797ab3c560bca2d916b50b5df49003a22e2f77b5ec2b1c37430d54" }, "downloads": -1, "filename": "yaml2rst-0.3-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "3049d5ff40f229563bd59c97ba223f14", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8358, "upload_time": "2019-04-03T11:58:43", "url": "https://files.pythonhosted.org/packages/93/af/1720183746de57e8a9dba661e65afc8afe0fc490fc7a8cd044f7cd3cf3c4/yaml2rst-0.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ccbefec2037523764216b706f7379c19", "sha256": "b517836b5d84d76b5b479ea8ba59bddef3f7bbe3bbb8ba770334b2dd2856b28b" }, "downloads": -1, "filename": "yaml2rst-0.3.tar.gz", "has_sig": true, "md5_digest": "ccbefec2037523764216b706f7379c19", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26366, "upload_time": "2019-04-03T11:58:45", "url": "https://files.pythonhosted.org/packages/de/88/1685f29d0627ec24bb0ccf790a4f1d0d276a4949db4288835163bd9b8c66/yaml2rst-0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "3049d5ff40f229563bd59c97ba223f14", "sha256": "e563869fb1797ab3c560bca2d916b50b5df49003a22e2f77b5ec2b1c37430d54" }, "downloads": -1, "filename": "yaml2rst-0.3-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "3049d5ff40f229563bd59c97ba223f14", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8358, "upload_time": "2019-04-03T11:58:43", "url": "https://files.pythonhosted.org/packages/93/af/1720183746de57e8a9dba661e65afc8afe0fc490fc7a8cd044f7cd3cf3c4/yaml2rst-0.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ccbefec2037523764216b706f7379c19", "sha256": "b517836b5d84d76b5b479ea8ba59bddef3f7bbe3bbb8ba770334b2dd2856b28b" }, "downloads": -1, "filename": "yaml2rst-0.3.tar.gz", "has_sig": true, "md5_digest": "ccbefec2037523764216b706f7379c19", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26366, "upload_time": "2019-04-03T11:58:45", "url": "https://files.pythonhosted.org/packages/de/88/1685f29d0627ec24bb0ccf790a4f1d0d276a4949db4288835163bd9b8c66/yaml2rst-0.3.tar.gz" } ] }