Documentation

Automatic documentation from sources for MkDocs

ci documentation pypi version conda version gitter

Automatic documentation from sources, for MkDocs.

mkdocstrings_gif1

Features

  • Language agnostic: just like mkdocs, mkdocstrings is written in Python but is language-agnostic. It means you can use it for any language, as long as you implement a handler for it. Currently, we only have a Python handler. Maybe you’d like to contribute another one
    ?
    ?
  • Multiple themes support: each handler can offer multiple themes. Currently, we offer the
    ⭐
    Material theme
    ⭐
    as well as basic support for the ReadTheDocs theme for the Python handler.
  • Cross-references to other

     

     

     

    To finish reading, please visit source site