mkdocs plugin to generate API documentation for Python programs
Project description
mkdocs-apidescribed-plugin
https://github.com/idlesign/mkdocs-apidescribed-plugin
Description
mkdocs plugin to generate API documentation for Python programs
- Made to autodocument Python code
- Plays well with Material for MkDocs
- Configurable
- Easy to use
Just add ::: apidescribed: directive into your documentation followed by a module path:
This is my documentation
::: apidescribed: somepackage.somemodule
Documentation
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 mkdocs_apidescribed_plugin-1.0.0.tar.gz.
File metadata
- Download URL: mkdocs_apidescribed_plugin-1.0.0.tar.gz
- Upload date:
- Size: 10.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.6.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d945920b72d15784026a3c2e5a671f86f5fa92cd0007b0ef187cbb6c4d6e4276
|
|
| MD5 |
402f826e4782d6fb7210a9ceb20e799a
|
|
| BLAKE2b-256 |
0c345ca463fc50bc678226e6e9cd251d5ee2b093cad240e90606450ca7da984f
|
File details
Details for the file mkdocs_apidescribed_plugin-1.0.0-py3-none-any.whl.
File metadata
- Download URL: mkdocs_apidescribed_plugin-1.0.0-py3-none-any.whl
- Upload date:
- Size: 2.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.6.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0350bd9f5b2059c860601edb0f539d4e86eb1bd5d2349d3858d81433b7af3ba6
|
|
| MD5 |
60f2dfa9648ea8603e418709da26a034
|
|
| BLAKE2b-256 |
d6b982cff94bdc42a7072167f677580d2406ecdb70be6b3f23a0801aac7f64fe
|
