{"id":19159487,"url":"https://github.com/creisle/markdown_refdocs","last_synced_at":"2025-05-07T08:42:28.346Z","repository":{"id":44735381,"uuid":"251523803","full_name":"creisle/markdown_refdocs","owner":"creisle","description":"Generate reference documentation from python package in markdown","archived":false,"fork":false,"pushed_at":"2022-01-27T21:26:57.000Z","size":2010,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-14T12:53:32.308Z","etag":null,"topics":["documentation-tool","markdown","python","reference"],"latest_commit_sha":null,"homepage":"https://creisle.github.io/markdown_refdocs","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/creisle.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}},"created_at":"2020-03-31T06:53:45.000Z","updated_at":"2023-04-15T14:53:29.000Z","dependencies_parsed_at":"2022-09-11T20:11:06.180Z","dependency_job_id":null,"html_url":"https://github.com/creisle/markdown_refdocs","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/creisle%2Fmarkdown_refdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/creisle%2Fmarkdown_refdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/creisle%2Fmarkdown_refdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/creisle%2Fmarkdown_refdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/creisle","download_url":"https://codeload.github.com/creisle/markdown_refdocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252845359,"owners_count":21813226,"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":["documentation-tool","markdown","python","reference"],"created_at":"2024-11-09T08:49:20.586Z","updated_at":"2025-05-07T08:42:28.312Z","avatar_url":"https://github.com/creisle.png","language":"Python","readme":"# Markdown Refdocs\n\n![build](https://github.com/creisle/markdown_refdocs/workflows/build/badge.svg) [![PyPi](https://img.shields.io/pypi/v/markdown_refdocs.svg)](https://pypi.org/project/markdown-refdocs) [![codecov](https://codecov.io/gh/creisle/markdown_refdocs/branch/master/graph/badge.svg)](https://codecov.io/gh/creisle/markdown_refdocs) ![PyPI - Downloads](https://img.shields.io/pypi/dm/markdown_refdocs)\n\nExtracts docstings and type annotations from a python package to generate reference documentation in markdown.\nSee an example of this at: https://creisle.github.io/markdown_refdocs/\n\n## Getting Started\n\nInstall the package from pip\n\n```bash\npip install markdown_refdocs\n```\n\nRun this from the command line or import the function to get the markdown returns as strings and\ncustomize. This tool has the customary help manu you can view with the `-h` option to see the\noptions documentation\n\n```bash\nmarkdown_refdocs -h\n```\n\nGenerate markdown reference documentation from your python package like so\n\n```bash\nmarkdown_refdocs /path/to/python/package -o /path/to/output/dir\n```\n\nThis will generate markdown files under `/path/to/output/dir` which can\nbe used standalone or incorporated in a [Mkdocs](https://www.mkdocs.org/) build\n\n## Examples\n\nDocumentation for this package itself can be generated using this tool itself\n\n```bash\nmarkdown_refdocs markdown_refdocs -o docs/reference\n```\n\nThis will build the following files (1 file per python sub-module)\n\n```text\ndocs/reference/\n└── markdown_refdocs\n    ├── links.md\n    ├── main.md\n    ├── markdown.md\n    ├── parsers.md\n    └── types.md\n```\n\nSee a live demo of this under: https://creisle.github.io/markdown_refdocs\n\n## Features\n\n- parses google-style docstrings\n- generates markdown output (this allows the user to link into the navigation or their main docs)\n- can take package directories as input\n- reads type annotations\n- pulls function signatures\n\n## Limitations\n\n- currently only supports [google-style docstrings](http://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings). May add support for others later if requested.\n\n## Motivation\n\nThe motivation for this package was that writing docs in\nmarkdown is simpler to read and write than writing them in RST. There is an awesome package called\n[Mkdocs](https://www.mkdocs.org/) for turning your markdown documents into a static site. It has a\nnumber of plugins which extract docstrings from python files, however none of them\nare able to use the google docstring format which I prefer. If you're using a different docstring\nformat you can check them out here on the [Mkdocs plugin wiki](https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins#api-documentation-building).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcreisle%2Fmarkdown_refdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcreisle%2Fmarkdown_refdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcreisle%2Fmarkdown_refdocs/lists"}