griffe-fieldz

griffe-fieldz

Griffe extension adding support for dataclass-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:

• dataclasses.dataclass
• pydantic.BaseModel
• attrs.define
• msgspec.Struct

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

You may use any of the following options, provided as a dictionary under the griffe_fieldz key.

Option	Description	Default
include_inherited	Include inherited fields in class parameters.	False
include_private	Include private fields in the documentation.	False

For example:

        options:
          extensions:
          - griffe_fieldz: {include_inherited: true}