NVIDIA / earth2studio

Open-source deep-learning framework for exploring, building and deploying AI weather/climate workflows.
https://nvidia.github.io/earth2studio/
Apache License 2.0
73 stars 23 forks source link

Fix typos and sphinx warnings in docs #86

Closed sahnimanas closed 2 months ago

sahnimanas commented 2 months ago

Earth2Studio Pull Request

Description

Checklist

Dependencies

None

NickGeneva commented 2 months ago

"Many dosctrings refer to a prognostic model even though they don't seem to be talking about a prognostic model."

These are almost guaranteed to be copy-paste typos from refactoring! Feel free to edit, I can catch any that arent correct in the reviews!

NickGeneva commented 2 months ago

/blossom-ci

NickGeneva commented 2 months ago

"The sphinx run with make docs is now almost completely clean. The only remaining warnings are from missing methods requested by automethod"

Yeah this is artifact of the template that we use to not manually write the auto doc commands. Its nice but complains when a function isnt found. Never found a good way around it.

sahnimanas commented 2 months ago

@NickGeneva I updated the stray occurences of "prognostic model". Most were in earth2studio/statistics, please take a look

Yeah this is artifact of the template that we use to not manually write the auto doc commands. Its nice but complains when a function isnt found. Never found a good way around it.

We should be able to use sphinx-jinja to guard the automethod call inside a jinja if block. Played around with it but couldn't get it to work, abandoning for now

sahnimanas commented 2 months ago

/blossom-ci

NickGeneva commented 2 months ago

/blossom-ci

NickGeneva commented 2 months ago

/blossom-ci