search

mansenfranzen / autodoc_pydantic

Seamlessly integrate pydantic models in your Sphinx documentation.
MIT License
159 stars 27 forks source link

model_computed_fields is shown in rendered output #201

Closed spacemanspiff2007 closed 8 months ago

spacemanspiff2007 commented 9 months ago

autodoc_pydantic 2.0.1

Pydantic 2.6.0 introduced a change for model_computed_fields. Now this is rendered for every Model that is documented:

grafik

j-carson commented 9 months ago

It looks like there is a hardcoded list of "model_" items to suppress - https://github.com/mansenfranzen/autodoc_pydantic/blob/1d14f120373e481023de889711210f4d2a2b853c/sphinxcontrib/autodoc_pydantic/directives/autodocumenters.py#L213

mansenfranzen commented 8 months ago

Done via #202

mansenfranzen commented 8 months ago

Before merging the related PR, it would be great if you could test the changed behavior. To do so, please install the current dev release in your doc-building-environment via pip install git+https://github.com/mansenfranzen/autodoc_pydantic.git@v2.1.0-a.1 and rebuild your docs.

Please feel free to reopen if any problem remains. I will release the new version upcoming Monday.