{"repo":"daizutabi/mkapi","free":true,"listed":false,"github":"https://github.com/daizutabi/mkapi","clone":"git clone https://github.com/daizutabi/mkapi.git","description":"MkDocs plugin for automatic API documentation generation from Python docstrings","language":"Python","stars":126,"topics":["api-documentation","markdown","mkdocs-plugin"],"license":"MIT","category":"productivity","readme_excerpt":"MkAPI [![PyPI Version][pypi-v-image]][pypi-v-link] [![Python Version][python-v-image]][python-v-link] [![Build Status][GHAction-image]][GHAction-link] [![Coverage Status][codecov-image]][codecov-link] MkAPI is a plugin for MkDocs, designed to facilitate the generation of API documentation for Python projects. MkAPI streamlines the documentation process by automatically extracting docstrings and organizing them into a structured format, making it easier for developers to maintain and share their API documentation. MkAPI supports two popular styles of docstrings: Google style and NumPy style, allowing developers to choose the format that best fits their project's needs. See the Napoleon documentation for details about these two styles. MkAPI is equipped with several key features that enhance the documentation experience: - Type Annotation Support : Automatically incorporates type annotations from function definitions into the documentation, reducing redundancy and improving clarity. - Object Type Inspection : Analyzes Python objects to determine their types, enabling accurate representation in the documentation. - Docstring Inheritance : Supports inheritance of docstring content from parent classes, ensuring that subclasses retain relevant documentation without duplication. - Automatic Table of Contents Generation : Generates a table of contents for each package, module, and class, improving navigation within the documentation. - Bidirectional Links : Creates links between the ","default_branch":null,"files":null,"tree":[],"storefront":"/r/daizutabi","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/daizutabi/mkapi/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."}