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
1 maintainer
Metadata
1 maintainer
Release files for mkdocstrings-sourcelink 0.3.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocstrings_sourcelink-0.3.2.tar.gz | 15.7 kB | Without provenance | Details for mkdocstrings_sourcelink-0.3.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocstrings_sourcelink-0.3.2-py3-none-any.whl | Python 3 | none | any | Details for mkdocstrings_sourcelink-0.3.2-py3-none-any.whl |
Total release size: 29.4 kB
Release files / mkdocstrings_sourcelink-0.3.2.tar.gz
| Download URL | mkdocstrings_sourcelink-0.3.2.tar.gz |
|---|---|
| Size | 15.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bc713a8c9587877a4bd55845409fad897e3e760601915225ef27655e027259d3
|
|
BLAKE2b-256 checksum How to use checksums |
bfc6309d7fc0dcf34696d50e0c23f6a0442634a4257ce62cf8151532a59d3331
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / mkdocstrings_sourcelink-0.3.2-py3-none-any.whl
| Download URL | mkdocstrings_sourcelink-0.3.2-py3-none-any.whl |
|---|---|
| Size | 13.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
057a28295abf663990cd7b0849a9046cebf170e8e1b8bd3459d00a33b82390d3
|
|
BLAKE2b-256 checksum How to use checksums |
3bf4a80bb73465fa5954dbd10747e41dea172df22874a53d3615364dcb6f001c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Security for mkdocstrings-sourcelink 0.3.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
