mkdocstrings
An MkDocs plugin used to render the docstrings of Python objects directly onto documentation pages, with support for cross-references.
Timeline (last 90 days)
The mkdocstrings website currently displays a maintenance-mode banner, but it is still usable and widely deployed by large projects such as Ansible.
MkDocs uses Markdown and a single mkdocs.yml to generate a static site, and the mkdocstrings plugin can inject live Python objects into pages, rendering docstrings with `:::` plus an identifier.
intersphinx allows linking from one project's documentation to another project's API pages, and mkdocstrings can achieve a similar cross-reference effect through handlers configuration.
All Facts (3)
The mkdocstrings website currently displays a maintenance-mode banner, but it is still usable and widely deployed by large projects such as Ansible.
50%UnverifiedMkDocs uses Markdown and a single mkdocs.yml to generate a static site, and the mkdocstrings plugin can inject live Python objects into pages, rendering docstrings with `:::` plus an identifier.
50%Unverifiedintersphinx allows linking from one project's documentation to another project's API pages, and mkdocstrings can achieve a similar cross-reference effect through handlers configuration.
50%