Is your feature request related to a problem? Please describe.
The pyrealm_build_data package contains modules for each test data set in the package, mostly used for regression tests of pyrealm against other implementations. At the moment, this is documented in a separate page in the docs:
However, that splits the description of the data away from the package. If we put the same information within an __init__.py file in each data module, we could then use the autodoc API to build a reference page while keeping the source information alongside the data. That would also then automate the addition of new test datasets to the documentation.
Describe alternatives you've considered
We could leave it as it is, extending the docs/source/development/pyrealm_build_data.md notebook, or put README.md in each module, but using autodoc kills two birds with one stone.
Is your feature request related to a problem? Please describe.
The
pyrealm_build_datapackage contains modules for each test data set in the package, mostly used for regression tests ofpyrealmagainst other implementations. At the moment, this is documented in a separate page in the docs:https://pyrealm.readthedocs.io/en/latest/development/pyrealm_build_data.html
However, that splits the description of the data away from the package. If we put the same information within an
__init__.pyfile in each data module, we could then use theautodocAPI to build a reference page while keeping the source information alongside the data. That would also then automate the addition of new test datasets to the documentation.Describe alternatives you've considered We could leave it as it is, extending the
docs/source/development/pyrealm_build_data.mdnotebook, or put README.md in each module, but usingautodockills two birds with one stone.