Adding documentation

[CorradoMotta]

Issue: Generate documentation that can be accessed by GitHub directly and explains all steps to generate the NetCDF files.

[CorradoMotta]

The way I generated the sphinx documentation with the sphinx theme:

• Install sphinx and sphinx-rtd-theme
• Create a docs folder in your root, navigate to it by using the terminal and run the following command (make sure you are in the correct conda environment): $ sphinx-quickstart
• Go into the docs folder. A number of files are generated. Open and modify the conf.py one. (you can find conf.py in this repository). Now you are ready to modify the rst file as you want.
• open the terminal, navigate to the docs folder and run $ make html. You can also make pdf or latex.

now the documentation is generated and can be opened by clicking on index.html

To be able to add it on GitHub pages, follow this guide: https://python.plainenglish.io/how-to-host-your-sphinx-documentation-on-github-550254f325ae

[CorradoMotta]

When you want to update the docs, but new code was added to main and pushed on remote:

• git checkout <localdocbranch>
• git rebase main (Will rework your commits to the top of master. Not ask for commits)
• Do the changes required to the docs folder. Do not make changes elsewhere to not cause conflicts.
• Add and commit your changes.
• git push --force-with-lease origin <localdocbranch>:<remotedocbranch>
• Ready to checkout to main again.

[CorradoMotta]

Right now i am manually adding the link to the created HTML page for variables metadata. That should be automatic.

Steps:

• Understand how to do it from markdown
• Rebase

[CorradoMotta]

Fixed. Next, we need to rebase and update the tables directly from notebooks without the need to recompile the documentation

[CorradoMotta]

merging to master

[CorradoMotta]

Issue can be closed