mkdocstrings
Automatic documentation from sources, for MkDocs.
Come have a chat or ask questions on our Gitter channel.
Features - Installation - Quick usage
Features
Language-agnostic:
just like MkDocs, mkdocstrings is written in Python but is language-agnostic.
It means you can use it with any programming language, as long as there is a
handler for it.
We currently have handlers
for the Crystal, Python,
and VBA languages,
as well as for shell scripts/libraries.
Maybe you'd like to add another one to the list? :wink:
Multiple themes support:
each handler can offer multiple themes. Currently, we offer the
:star: Material theme :star:
as well as basic support for the ReadTheDocs and MkDocs themes for the Python handler.
Cross-references across pages:
mkdocstrings makes it possible to reference headings in other Markdown files with the classic Markdown linking
syntax: [identifier][] or [title][identifier] -- and you don't need to remember which exact page this object was
on.
|