-
Notifications
You must be signed in to change notification settings - Fork 65
Docstrings -> pydantic fields. #124
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
This is actually pretty awesome. Glad you're doing it. Copying over docstrings was both a nuisance and just seemed wrong... Let me know if you want to run anything specific by me, otherwise looks good to me. |
|
Thanks, yea I think it will be good to do. Still a lot of work to clean things up and pretty up the docs. I think once it's closer to completion I might pick your brain on a thing or two, mainly regarding how the docs should look. |
…amp into field_docs
Major changes to how the pydantic models are defined and the docs are generated:
Instead of all information being contained in docstrings, each field itself will have some metadata. For example
This metadata is written into the schema in the appropriate place, making everyone's lives easier.
We then use
autodoc-pydanticsphinx plugin to generate the docs.Note: this is a WIP.