Document pandera model with sphinx

[Timost]

Question about Pandera

Hi,

First of all, thank you for making pandera. 🙏

@strayMat and I are thinking of building a simple sphinx (autodoc) extension to document pandera models automatically (heavily inspired from https://github.com/mansenfranzen/autodoc_pydantic).

Is that something that you have in mind ? AFAICT there is no such thing yet.

Our goal is to have a single Python Object that we can use to:

1. Describe data model
2. Validate data
3. Document data

This has been mentioned on sphinx's side in this issue sphinx-doc/sphinx#10373

[cosmicBboy]

Hi @Timost! You and @strayMat have my blessing to go ahead with this project! Sounds awesome and valuable to the community. Looks like autodoc-pandera is free on pypi 🙂

Please feel free to ping me in your repo once you get the project going, would love to chime in if you have any questions.

[Timost]

Hi !

Thank you for your kind words, this will take a time (kind of a pair-programming side project) but we will keep you posted 👍