Я использую mkdocs
для автоматического создания документации для своего проекта. Однако для классов, наследуемых от pydantic.BaseModel
, я считаю утомительным включать строку документации для каждого поля с описанием и типом данных, поскольку эта информация уже включена в аргументы pydantic.Field
. Вот пример:
class MyModel(BaseModel):
"""This text is good.
:param field_1: redundant description and default value.
:type field_1: redundant type
"""
field_1: int = Field(default=3, description = "description")
Есть ли способ добавить поддержку моделей pydantic
? Я просмотрел Интернет, но это кроличья нора, и я новичок во всем этом процессе. Любая помощь приветствуется!
Возможно, вас заинтересует расширение griffe-fieldz для Griffe, инструмента, который извлекает информацию из источников Python (статически или динамически).
Также есть расширение griffe-pydantic, которое я создал сам (я являюсь сопровождающим mkdocstrings), но пока оно доступно только спонсорам.
Именно то, что я хотел. Спасибо!