Automatic source link generation for mkdocstrings
mkdocstrings-sourcelink is a source link generator for mkdocstrings, which allows connecting the source code to a repository independent of the host (GitHub, GitLab, own Services).
The original idea of mkdocstrings-sourcelink was coming from keras-autodoc and used as inspiration. However, this implementation focuses on using straight mkdocstrings and not rephrase docstrings into the documentation. Furthermore, mkdocstrings-sourcelink also allows:
- Generating API list
- Using templates and examples
- Importing existing markdown files like README.md
pip install mkdocstrings-sourcelinkThe usage requires just three steps:
❯ python generate_docs.py❯ mkdocs.yml❯ mkdocs deploy