MkAPI
MkAPI is a plugin for MkDocs to generate API documentation for your Python project.
MkAPI supports two styles of docstrings: Google and NumPy. See Napoleon documentation for details.
Screenshots
Schemdraw (package tree view & package summary)
Polars (class documentation & link to source code)
Altair (table of contents)
Features
- Type annotation: If you write your function such as
def func(x: int) -> str:, you don't need write type(s) in Parameters, Returns, or Yields section again. You can override the type annotation in the corresponding docstring. - Object type inspection: MkAPI plugin creates class, dataclass, function, method, property prefix for each object.
- Docstring inheritance: Docstring of a subclass can inherit parameters and attributes description from its superclasses.
- Table of Contents: Table of contents are inserted into the documentation of each package, module, and class.
- Bidirectional Link: Bidirectional links are created between documentation and source code.
Installation
Install the MkAPI plugin using pip:
pip install mkapi
Configuration
Add the following lines to mkdocs.yml:
plugins:
- mkapi
Usage
MkAPI provides two modes to generate API documentation: Object mode and Page mode.
Object Mode
To generate the API documentation in a Markdown source, add three colons + object full name. The object can be a function, class, attribute, or module.
::: package.module.object
The Object mode is useful to embed an object documentation in an arbitrary position of a Markdown source. For more details, see Object mode.
Page Mode
Using the Page mode, you can construct a comprehensive API documentation
for your project.
You can get this powerful feature by just one line in mkdocs.yml:
nav:
- index.md
- API: $api/package.***
For more details, see Page mode.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkapi-2.1.0.tar.gz.
File metadata
- Download URL: mkapi-2.1.0.tar.gz
- Upload date:
- Size: 52.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.26.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
59f40f8cf91eda440d48614c2f123ac053751d306de752d17c9403789a9784ef
|
|
| MD5 |
36de2576139bba7f1c0ef5247493121a
|
|
| BLAKE2b-256 |
298ee901926bbdef8b224932a3681467630a0dadff7a15772eb100e362de73eb
|
File details
Details for the file mkapi-2.1.0-py3-none-any.whl.
File metadata
- Download URL: mkapi-2.1.0-py3-none-any.whl
- Upload date:
- Size: 38.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.26.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c7a65e715fa124f031496884fdc74d90c78cec23913500f3394ecd590e87a174
|
|
| MD5 |
37ea68e0bda5c63aafa7d9fda5d3bdfa
|
|
| BLAKE2b-256 |
4149d40cfcf4f6fc74d032adc3d75eb7566cae10174f68f5eee5d9bf4f3012bb
|
