Metadata-Version: 2.4
Name: mkdocs-apidescribed-plugin
Version: 1.1.0
Summary: mkdocs plugin to generate API documentation for Python programs
Project-URL: Homepage, https://github.com/idlesign/mkdocs-apidescribed-plugin
Project-URL: Documentation, https://mkdocs-apidescribed-plugin.readthedocs.org/
Author-email: Igor Starikov <idlesign@yandex.ru>
License-Expression: BSD-3-Clause
License-File: LICENSE
Keywords: api,mkdocs,plugin
Requires-Python: >=3.10
Requires-Dist: griffe
Requires-Dist: mkdocs
Requires-Dist: pyyaml
Description-Content-Type: text/markdown

# mkdocs-apidescribed-plugin

https://github.com/idlesign/mkdocs-apidescribed-plugin

[![PyPI - Version](https://img.shields.io/pypi/v/mkdocs-apidescribed-plugin)](https://pypi.python.org/pypi/mkdocs-apidescribed-plugin)
[![License](https://img.shields.io/pypi/l/mkdocs-apidescribed-plugin)](https://pypi.python.org/pypi/mkdocs-apidescribed-plugin)
[![Coverage](https://img.shields.io/coverallsCoverage/github/idlesign/mkdocs-apidescribed-plugin)](https://coveralls.io/r/idlesign/mkdocs-apidescribed-plugin)
[![Docs](https://img.shields.io/readthedocs/mkdocs-apidescribed-plugin)](https://mkdocs-apidescribed-plugin.readthedocs.io/)

## Description

*mkdocs plugin to generate API documentation for Python programs*

* Made to autodocument Python code
* Plays well with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
* Configurable
* Easy to use

Just add ``::: apidescribed:`` directive into your documentation followed by a module path:

```md title="index.md"
This is my documentation

::: apidescribed: somepackage.somemodule

```

## Documentation

https://mkdocs-apidescribed-plugin.readthedocs.io/
