[paul-leopardi]

Closes #160
The draft documentation was produced using Google Gemni 3.8 Flash

[read-the-docs-community]

Documentation build overview

📚 CMIP7-Input | 🛠️ Build #35104853 | 📁 Comparing 58e1ca0 against latest (d1cfb65)

  🔍 Preview build  

2 files changed

± 404.html
± index.html

[atteggiani]

Thank you @paul-leopardi for working on this documentation update.

I think the overall changes could be classified in two main categories: docstrings changes (or in general any documentation/comment added directly in the source code) and documentation changes.

First, I would separate these changes in two different PRs, as they can be reviewed independently (and this makes it easier to review the documentation changes without having the visual clutter of all changed python code). Therefore, I would keep only the docstrings changes in this PR.

Docstrings changes

I haven't looked at the docstrings in detail, but I think for the moment it's a good idea to have some docstrings for all the functions, so when we refactor the code we have some help understanding what the function does.
Just noting that these docstrings will likely change when the functions get refactored and integrated in the new python package.

Documentation changes

Any documentation change should be developed on top of #163, which configures documentation according to the current ACCESS-NRI standards.

Also, I am not sure documentation changes are required at this point. The main reason is that the status of the code will change drastically after the refactoring and integration in the new python package. Therefore, documentation will need to be changed accordingly.
Currently this documentation is an "AI snapshot" of what's currently in the repo. I think something like this would be easier with a link to DeepWiki (we could add its badge to the README).

[paul-leopardi]

Hi Davide, I have revised this pull request to include only the docstring changes and have stacked it onto #167 . The RTD failure is because .readthedocs.yaml is missing in this branch.

[atteggiani]

Thank you @paul-leopardi for only including the docstrings changes.

I haven't properly looked at all of them, but for the reasons mentioned above, I think this is good for now.
Thanks