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
Metadata
Release files for mkdocs-apidescribed-plugin 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_apidescribed_plugin-1.2.0.tar.gz | 11.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_apidescribed_plugin-1.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 25.3 kB
Release files / mkdocs_apidescribed_plugin-1.2.0.tar.gz
| Download URL | mkdocs_apidescribed_plugin-1.2.0.tar.gz |
|---|---|
| Size | 11.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d2f9ec179f0e1d4313357f83bb4efe2def3b7c8661da697d3dde77b72a05aa67
|
|
BLAKE2b-256 checksum How to use checksums |
2d80fc28f2cd01b40036f5e25faba7e7a4a6aef0f3999c363f639c2f9c240a74
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.6.6
|
Release files / mkdocs_apidescribed_plugin-1.2.0-py3-none-any.whl
| Download URL | mkdocs_apidescribed_plugin-1.2.0-py3-none-any.whl |
|---|---|
| Size | 14.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bbb021288fb61bb9108232737238c2e354c5a5f1ffa2572519e032fd87386b38
|
|
BLAKE2b-256 checksum How to use checksums |
e3d9efcc8a1ad214057b2b9c991c59a098223fe53bf42e54509741196fd363f3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.6.6
|