{"repo":"ml-tooling/lazydocs","free":true,"listed":false,"github":"https://github.com/ml-tooling/lazydocs","clone":"git clone https://github.com/ml-tooling/lazydocs.git","description":"📖 Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx.","language":"Python","stars":250,"topics":["docstring","mkdocs","markdown","pydoc","sphinx","google-style","api-docs","api-docs-generator","python-api"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"lazydocs Generate markdown API documentation for Google-style Python docstring. Getting Started • Features • Documentation • Support • Contribution • Changelog Lazydocs makes it easy to generate beautiful markdown documentation for your Python API (see this example). It provides a simple command-line interface as well as a Python API to get full-fledged API documentation within seconds based on all of the Google-style docstrings in your code. This markdown documentation can be pushed to Github or integrated into your MkDocs site. Highlights - ⏱  Simple CLI to generate markdown docs in seconds. - 📋  Supports Google-style Python Docstrings. - 📚  Compatible with Github Markdown and MkDocs. Getting Started Installation Requirements: Python 3.9+. Usage To generate Markdown-based API documentation for your Python project, simply execute: The path can be either a python package (folder) or a specific script. You can also specify one or multiple module-, class- or function-imports: With the default configuration, the Markdown documentation will be generated inside the ./docs folder in your working directory. You can find additional configuration options in the documentation section. Support & Feedback This project is maintained by Benjamin Räthlein, Lukas Masuch, and Jan Kalkan. Please understand that we won't be able to provide individual support via email. We also believe that help is much more valuable if it's shared publicly so that more people can benefit from i","default_branch":null,"files":null,"tree":[],"storefront":"/r/ml-tooling","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/ml-tooling/lazydocs/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."}