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
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
File details
Details for the file mkdocstrings_sourcelink-0.3.2.tar.gz.
File metadata
- Download URL: mkdocstrings_sourcelink-0.3.2.tar.gz
- Upload date:
- Size: 15.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bc713a8c9587877a4bd55845409fad897e3e760601915225ef27655e027259d3 |
|
| MD5 | 4dccb6ba4be7816366ea937ba38ec7bd |
|
| BLAKE2b-256 | bfc6309d7fc0dcf34696d50e0c23f6a0442634a4257ce62cf8151532a59d3331 |
File details
Details for the file mkdocstrings_sourcelink-0.3.2-py3-none-any.whl.
File metadata
- Download URL: mkdocstrings_sourcelink-0.3.2-py3-none-any.whl
- Upload date:
- Size: 13.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 057a28295abf663990cd7b0849a9046cebf170e8e1b8bd3459d00a33b82390d3 |
|
| MD5 | 219e45a15e329eaed34d684b5f138337 |
|
| BLAKE2b-256 | 3bf4a80bb73465fa5954dbd10747e41dea172df22874a53d3615364dcb6f001c |
