Griffe extension for inheriting docstrings.
Project description
Griffe Inherited Docstrings
Griffe extension for inheriting docstrings.
Installation
With pip
:
pip install griffe-inherited-docstrings
With pipx
:
python3.8 -m pip install --user pipx
pipx install griffe-inherited-docstrings
Usage
With Python:
import griffe
griffe.load("...", extensions=griffe.load_extensions(["griffe_inherited_docstrings"]))
With MkDocs and mkdocstrings:
plugins:
- mkdocstrings:
handlers:
python:
options:
extensions:
- griffe_inherited_docstrings
The extension will iterate on every class and their members to set docstrings from parent classes when they are not already defined.
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 griffe_inherited_docstrings-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c827ce1a571ada3fdc0f74be05ba31e40743cc909c9463fac60779a57d387e60 |
|
MD5 | 880f6065576829e2efdf66773117eaf1 |
|
BLAKE2b-256 | a1f0b17c66dfc32cd5944ef9f738ecec4c194f857abf66be3c14edc2ca743cda |
Close
Hashes for griffe_inherited_docstrings-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76854a4fc10acabe223cd5cbd42637e45cafb30dcaf36f120c4752fca99e48a8 |
|
MD5 | 0c2fbb23774007cb70b0f61c2ee921d0 |
|
BLAKE2b-256 | 9f79ffef1e72a3035f07a531e216d6b2075755a449441a043caa23a254f7611a |