TheochemUI / eOn

eOn v3 and beyond
https://theochemui.github.io/eOn/
BSD 3-Clause "New" or "Revised" License
2 stars 2 forks source link

DOC,MAINT: Extract the option descriptions into a schema #129

Closed HaoZeke closed 2 months ago

HaoZeke commented 2 months ago

This is actually done for the parameter switch in #86, however it is also useful for the documentation. Basically coupling the documentation to the actual definitions via the pydantic schema produces "always updated" doc strings: https://sphinx-pydantic.readthedocs.io/en/latest/