Skip to content

Document Pydantic models with mkdocstrings

Context

We need to auto document Pydantic models in the library, drawing them as tables.

Library Draws tables? Last Update
mkdocstrings No
mkapi No
mkdoxy No
mkautodoc No
inari No
automacdoc No
mkdocs-typedoc No
mkdocs-doxygen-plugin No
yaarg Yes 2021-03-14

Decision

  • Use mkdocstrings for now
  • Maybe file an issue about rendering Pydantic models there