Automatic source link generation for mkdocstrings.
Project description
mkdocstrings-sourcelink
Automatic source link generation for mkdocstrings
Overview
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
Installation
pip install mkdocstrings-sourcelink
Usage
The usage requires just three steps:
❯ python generate_docs.py
❯ mkdocs.yml
❯ mkdocs deploy
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocstrings_sourcelink-0.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56071069387fa8d9984f395f088605f73a5330ad460652853101e5c6771b1645 |
|
MD5 | 292c329e7d79a9349b4a8a59c397ddcd |
|
BLAKE2b-256 | 56dd3223761c105d8c8616a0cdea054fbf222d334fdc23d3c361133a6e977e8e |
Close
Hashes for mkdocstrings_sourcelink-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 463e9b5b9ce49d12d3157631bde2e699792ee475957ba618ca4c6dacfb6f3130 |
|
MD5 | d8cf16b55f353609f31fa8e17912feeb |
|
BLAKE2b-256 | 7d337313a0d8ae16436a622315d985113da47ca60ba940ad08f84a34c2c94cad |