{"repo":"criccomini/python-docstring-markdown","free":true,"listed":false,"github":"https://github.com/criccomini/python-docstring-markdown","clone":"git clone https://github.com/criccomini/python-docstring-markdown.git","description":"Generates Markdown documentation from Python module dosctrings","language":"Python","stars":16,"topics":["docstrings","documentation","docusaurus","gitbook","markdown","mkdocs","readthedocs","sphinx"],"license":"CC0-1.0","category":"docs-static-sites","readme_excerpt":"python-docstring-markdown A Python module and CLI that walks a Python package/directory and outputs a Markdown file from all docstrings in the package. Tools 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. Features - Crawls the packages, modules, classes, functions, and methods using the ast module - Auto-detects ReST, Google, Numpydoc-style and Epydoc docstrings using docstring-parser-fork - Generates a table of contents with anchor links - Tracks and documents module exports ( all ) - Preserves module hierarchy in documentation - Handles nested classes and functions Installation Usage Command Line Arguments: - package dir : Path to your Python package directory. - 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. Example: Python API Documentation See the DOCUMENTATION.md file for more information. It also serves as an example of how the documentation is generated. Contributing I welcome feedback and contributions! License CC-0 1.0 Universal. See the LICENSE file for more information.","default_branch":null,"files":null,"tree":[],"storefront":"/r/criccomini","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/criccomini/python-docstring-markdown/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}