Skip to main content

mkdocs-apidescribed-plugin

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

PyPI - Version License Coverage Docs

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

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

Metadata

Release files for mkdocs-apidescribed-plugin 1.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-apidescribed-plugin 1.3.0
File Size Uploaded Provenance Actions
mkdocs_apidescribed_plugin-1.3.0.tar.gz 11.5 kB Without provenance Details for mkdocs_apidescribed_plugin-1.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-apidescribed-plugin 1.3.0
File Interpreter ABI Platform Actions
mkdocs_apidescribed_plugin-1.3.0-py3-none-any.whl Python 3 none any Details for mkdocs_apidescribed_plugin-1.3.0-py3-none-any.whl

Total release size: 26.2 kB

Release files / mkdocs_apidescribed_plugin-1.3.0.tar.gz

Download URL mkdocs_apidescribed_plugin-1.3.0.tar.gz
Size 11.5 kB
Tags Source
SHA-256 checksum
How to use checksums
1eb16bb56f6585dd70876089c4646c75a88cf0fd19e647d1620738d0acafb843
BLAKE2b-256 checksum
How to use checksums
3e6bf8d7dee4e662bd558d3de146238aade5f52fffad32fea188fc5f180b8f08
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / mkdocs_apidescribed_plugin-1.3.0-py3-none-any.whl

Download URL mkdocs_apidescribed_plugin-1.3.0-py3-none-any.whl
Size 14.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c22388ddfa618b86a2d41a9fad6af3bcaa99460ba6cd1159b08701c2d76f5bda
BLAKE2b-256 checksum
How to use checksums
89e5f488884835e31ddbb3094738c5d2964889f89545ff694168234d01bd589d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for mkdocs-apidescribed-plugin 1.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page