CALIPSO-project / SPINacc

A spinup acceleration procedure for land surface models (LSM) . Developer team Mandresy Rasolonjatovo, Tianzhang Cai, Matthew Archer, Daniel Goll
4 stars 0 forks source link

Sphinx documentation #79

Open ma595 opened 1 month ago

ma595 commented 1 month ago

A useful way to provide documentation is with Sphinx (with read the docs - rtd - template). This would allow us to store all of the contributions ICCS have made as well as a tutorial and developer guide.

It could also provide the API to the users, taking docstring information from the code.

This could be deployed in an automated fashion using Github actions.