Griffe extension adding support for data-class like things (pydantic, attrs, etc...)
Project description
griffe-fieldz
Griffe extension adding support for data-class like things (pydantic, attrs, etc...). This extension will inject the fields of the data-class into the documentation, preventing you from duplicating field metadata in your docstrings.
It supports anything that fieldz supports, which is currently:
Installation
With pip
:
pip install griffe-fieldz
To use the extension in a MkDocs project, use this configuration:
# mkdocs.yml
plugins:
- mkdocstrings:
handlers:
python:
options:
extensions:
- griffe_fieldz
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
griffe_fieldz-0.1.0.tar.gz
(8.1 kB
view hashes)
Built Distribution
Close
Hashes for griffe_fieldz-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 762a1f69d9094fc2eafee0e003b79b68edb2a00b093204129794a2cefd71b0a7 |
|
MD5 | c25167d91fe870affbe3b9f74a8121e2 |
|
BLAKE2b-256 | 481205e8e2caed04d9ca2fe76d3b9d1ac94565e704646e3c6949bb4ea0c82b0e |