search

MetOffice / CATNIP

Climate Analysis Tool: Now In Python
Other
5 stars 2 forks source link

Documentation #3

Closed zmaalick closed 4 years ago

zmaalick commented 4 years ago

Get the basic set of documentation of the current function. This issue should be solved after getting regrouping of functions

gredmond-mo commented 4 years ago

I have updated the current sphinx documentation to include the new functions as well as example plots for those functions that output one. See https://www-hc/~gredmond/sphinx_ciid_tools/_build/html/tools.html

The downside is I had to make some changes to the fcm ciid_tools repo to do this, there was one minor mistake that I missed when reviewing, and I had to make small changes to the doc string formatting to comply with sphinx.

nhsavage commented 4 years ago

still to do:

  1. add sample data
  2. update docstrings to refer to new sample data location
balazagi commented 4 years ago

still to do:

  1. add sample data
  2. update docstrings to refer to new sample data location

I think this has now been address by b97fb3a and can be closed

balazagi commented 4 years ago

closed as it has been addressed