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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae3e2362af11f1eb95eb81a0ddc744d4fd05649f4ec749ea4559da033d863a46 |
|
MD5 | db34177ca993820f6f33437c4f26cdbf |
|
BLAKE2b-256 | ea696a961e124671cc48525f197d42b657f7bb3a7638ec2764caf7465d50c213 |
Close
Hashes for griffe_inherited_docstrings-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46a7861401022330d39d4e937e52bae4d8b309c943204720d737835214bad8bc |
|
MD5 | 08d7a0f5caf11f58ea4c7bec9b608862 |
|
BLAKE2b-256 | 8c81ffbd59a5eff9fbe9a21c96b1fb4c3f462089b32161b7673c81a9a98e1d63 |