{"id":16589235,"url":"https://github.com/coldfix/doc2md","last_synced_at":"2025-03-21T13:31:12.473Z","repository":{"id":10089249,"uuid":"12148563","full_name":"coldfix/doc2md","owner":"coldfix","description":"Extract python docstrings and save as markdown file [very lightweight and designed for my personal use case]","archived":false,"fork":false,"pushed_at":"2018-01-23T19:50:10.000Z","size":19,"stargazers_count":55,"open_issues_count":0,"forks_count":23,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-18T01:43:00.395Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coldfix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-08-16T02:08:40.000Z","updated_at":"2025-02-07T20:34:43.000Z","dependencies_parsed_at":"2022-09-05T17:22:24.299Z","dependency_job_id":null,"html_url":"https://github.com/coldfix/doc2md","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coldfix%2Fdoc2md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coldfix%2Fdoc2md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coldfix%2Fdoc2md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coldfix%2Fdoc2md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coldfix","download_url":"https://codeload.github.com/coldfix/doc2md/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244806082,"owners_count":20513375,"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":"2024-10-11T23:08:16.358Z","updated_at":"2025-03-21T13:31:12.196Z","avatar_url":"https://github.com/coldfix.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## doc2md\n\nSimplistic utility to extract docstrings from a module or class and throw\nthem into a simple [GitHub Flavoured Markdown](md) document. Its purpose is\nto quickly generate `README.md` files for small projects.\n\n[md]: https://help.github.com/articles/github-flavored-markdown\n\n- [Project status](#project-status)\n- [Installation](#installation)\n- [Usage](#usage)\n- [License](#license)\n- [API](#api)\n\n### Project status\n\nI stopped using this package and therefore will not push any updates (I now\nusually write README.rst manually). Nonetheless, you may still find it useful.\nShould you encounter bugs or have improvements, feel free to submit a PR. If\nyou want to take over maintenance, feel free to contact me.\n\nFor a more feature-rich and well maintained alternative, see:\n\n- https://github.com/NiklasRosenstein/pydoc-markdown/ (I didn't try it)\n\n\n### Installation\n\nNo installation necessary. However, if you want:\n\n```bash\n$ pip install doc2md\n```\n\n\n### Usage\n\nYou can run this script from the command line like:\n\n```bash\n$ doc2md.py [-a] [--no-toc] [-t title] [-d depth] module-name [class-name] \\\n    \u003e README.md\n```\n\nAt the moment  this is suited only  for a very specific use  case. It is\nhardly forseeable, if I will decide to improve on it in the near future.\n\nFor a simple example output document, see the generated README (i.e. the\ngithub frontpage). It is extracted from the `doc2md.py` file using this\nvery utility:\n\n```bash\n$ ./doc2md.py -a -d1 doc2md \u003e README.md\n```\n\n\n### License\n\nCopyright © 2013-2017 Thomas Gläßle \u003ct_glaessle@gmx.de\u003e\n\nThis work  is free. You can  redistribute it and/or modify  it under the\nterms of the MIT license. See the COPYING file for more details.\n\nThis program  is free software.  It comes  without any warranty,  to the\nextent permitted by applicable law.\n\n\n### API\n\n- [`doctrim`](#doctrim)\n- [`doc2md`](#doc2md)\n\n\n#### `doctrim`\n\nClean up indentation from docstrings.\n\nAny whitespace that can be uniformly removed from the second line\nonwards is removed.\n\n\n#### `doc2md`\n\nConvert a docstring to a markdown text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoldfix%2Fdoc2md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoldfix%2Fdoc2md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoldfix%2Fdoc2md/lists"}