Open JackKelly opened 2 years ago
I guess the ideal situation would be to automatically extract the
description
fields from thepydantic
models? I wonder if sphinx can do that?!
Yup, it can! https://sphinx-pydantic.readthedocs.io/en/latest/
The 'data_sources' are now basically 'xr.Datasets', with a few pydantic features.
Perhaps a good start is just to write a descirption in eahc of the data_sources/<modality>/<modality>_model.py
files
The Pydantic models in the
data_sources/
<modality>/<modality>_model.py
files (where<modality>
is one of {datetime, metadata, gsp, nwp, pv, satellite, sun, topographic}) describe the contents of the batches (and, hence, the contents of the NetCDF files). (For example, seesatellite_model.py
).But it might be nice to aggregate all that documentation together into a single human-readable page somewhere? So it's really quick and easy for users to get an overview (and to see the detail) of precisely what
nowcasting_dataset
outputs to disk?I guess the ideal situation would be to automatically extract the
description
fields from thepydantic
models? I wonder ifsphinx
can do that?!Related to #222