{"id":25661134,"url":"https://github.com/criccomini/python-docstring-markdown","last_synced_at":"2026-05-18T10:08:49.473Z","repository":{"id":278296128,"uuid":"935154018","full_name":"criccomini/python-docstring-markdown","owner":"criccomini","description":"Generates Markdown documentation from Python module dosctrings","archived":false,"fork":false,"pushed_at":"2025-08-28T19:11:39.000Z","size":75,"stargazers_count":12,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-29T11:43:27.644Z","etag":null,"topics":["docstrings","documentation","docusaurus","gitbook","markdown","mkdocs","readthedocs","sphinx"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/criccomini.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-02-19T01:49:33.000Z","updated_at":"2025-08-28T19:11:42.000Z","dependencies_parsed_at":"2025-08-28T21:09:00.720Z","dependency_job_id":"32cc9710-5c49-48c4-8fd6-3a2ac0eeb4f0","html_url":"https://github.com/criccomini/python-docstring-markdown","commit_stats":null,"previous_names":["criccomini/python-docstring-markdown"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/criccomini/python-docstring-markdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/criccomini%2Fpython-docstring-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/criccomini%2Fpython-docstring-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/criccomini%2Fpython-docstring-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/criccomini%2Fpython-docstring-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/criccomini","download_url":"https://codeload.github.com/criccomini/python-docstring-markdown/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/criccomini%2Fpython-docstring-markdown/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33174091,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-18T09:27:30.708Z","status":"ssl_error","status_checked_at":"2026-05-18T09:27:28.300Z","response_time":71,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["docstrings","documentation","docusaurus","gitbook","markdown","mkdocs","readthedocs","sphinx"],"created_at":"2025-02-24T02:28:06.072Z","updated_at":"2026-05-18T10:08:49.455Z","avatar_url":"https://github.com/criccomini.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# python-docstring-markdown\n\nA Python module and CLI that walks a Python package/directory and outputs a Markdown file from all docstrings in the package.\n\nTools like mkdocs and readthedocs are overkill for many small Python projects. This project exists to provide a simple way to generate Markdown documentation that can be stored alongside your code in Github.\n\n## Features\n\n- Crawls the packages, modules, classes, functions, and methods using the `ast` module\n- Auto-detects ReST, Google, Numpydoc-style and Epydoc docstrings using [`docstring-parser-fork`](https://pypi.org/project/docstring-parser-fork/)\n- Generates a table of contents with anchor links\n- Tracks and documents module exports (`__all__`)\n- Preserves module hierarchy in documentation\n- Handles nested classes and functions\n\n## Installation\n\n```bash\npip install python-docstring-markdown\n```\n\n## Usage\n\n### Command Line\n\n```bash\npython -m python_docstring_markdown \u003cpackage_dir\u003e \u003coutput_path\u003e\n```\n\nArguments:\n- `package_dir`: Path to your Python package directory.\n- `output_path`: Path where the Markdown documentation file will be saved. A path that ends in `.md` will result in a single file. A directory path will result in one `.md` per-module.\n\nExample:\n```bash\npython -m python_docstring_markdown ./src/my_package docs/api.md\n```\n\n### Python API\n\n```python\nfrom python_docstring_markdown import crawl\n\n# Generate documentation for a package\ndocs_content = crawl(\"./src/my_package\")\n\n# Save to a file\nwith open(\"docs/api.md\", \"w\") as f:\n    f.write(docs_content)\n```\n\n## Documentation\n\nSee the [DOCUMENTATION.md](DOCUMENTATION.md) file for more information. It also serves as an example of how the documentation is generated.\n\n## Contributing\n\nI welcome feedback and contributions!\n\n## License\n\nCC-0 1.0 Universal. See the [LICENSE](LICENSE) file for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcriccomini%2Fpython-docstring-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcriccomini%2Fpython-docstring-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcriccomini%2Fpython-docstring-markdown/lists"}