Model Field Output

[mansenfranzen]

Model Field Output

[mansenfranzen]

I'm glad it helped and thanks for the issue anyway. It inspired me to provide an additional default to automatically set :undoc-members: for pydantic models.

[TheBeardedBerserkr]

To be a little more clear how do I get these:

provides default values, alias and constraints for model fields

to generate? Is it a conf.py setting?

[mansenfranzen]

Hi,

thanks for opening the first issue ;-). Do your pydantic fields have doc strings? If not, sphinx autodoc will ignore them. To include undocumented members, add :undoc-members: :

.. automodule:: package.MyModel 
   :members:
   :undoc-members:

Please let me know if this works for you.

In any case, it seems to be a good idea to include undocumented pydantic fields regardless of the :undoc-members: option. This should be configurable of course.

[TheBeardedBerserkr]

That worked!
I figured it was a me thing! Still new to all this, pydantic, sphinx, autodocs so forgive the ignorance!
Hopefully all the issues are as easy as this one!