{"id":28583669,"url":"https://github.com/debops/yaml2rst","last_synced_at":"2025-06-11T05:10:12.922Z","repository":{"id":27069629,"uuid":"30535962","full_name":"debops/yaml2rst","owner":"debops","description":"A Simple Tool and Python-Module for Documenting YAML Files","archived":false,"fork":false,"pushed_at":"2020-01-02T19:39:42.000Z","size":81,"stargazers_count":18,"open_issues_count":2,"forks_count":12,"subscribers_count":6,"default_branch":"develop","last_synced_at":"2025-05-29T19:34:36.267Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/debops.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-09T13:01:01.000Z","updated_at":"2023-03-16T07:49:35.000Z","dependencies_parsed_at":"2022-07-18T02:46:48.099Z","dependency_job_id":null,"html_url":"https://github.com/debops/yaml2rst","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/debops%2Fyaml2rst","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/debops%2Fyaml2rst/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/debops%2Fyaml2rst/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/debops%2Fyaml2rst/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/debops","download_url":"https://codeload.github.com/debops/yaml2rst/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/debops%2Fyaml2rst/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259204814,"owners_count":22821162,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-11T05:10:11.292Z","updated_at":"2025-06-11T05:10:12.914Z","avatar_url":"https://github.com/debops.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"==========================\nyaml2rst\n==========================\n--------------------------------------------------------------------------\nA Simple Tool and Python-Module for Documenting YAML Files\n--------------------------------------------------------------------------\n\n:Author:    Hartmut Goebel \u003ch.goebel@crazy-compilers.com\u003e\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 \u003cdocs/fold-markers.rst\u003e`_ 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 \u003chttps://pypi.org/project/yaml4rst/\u003e`_ 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdebops%2Fyaml2rst","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdebops%2Fyaml2rst","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdebops%2Fyaml2rst/lists"}