Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

Latest commit

 

History

History
38 lines (26 loc) · 2.6 KB

README.md

File metadata and controls

38 lines (26 loc) · 2.6 KB

Python Package GitHub branch checks state pre-commit.ci status codecov Code Style: Black Language grade: Python PyPI - Python Version PyPI

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:

  1. Generating API list
  2. Using templates and examples
  3. Importing existing markdown files like README.md

Installation

pip install mkdocstrings-sourcelink

Usage

The usage requires just three steps:

  1. ❯ python generate_docs.py
  2. ❯ mkdocs.yml
  3. ❯ mkdocs deploy