Skip to content
Snippets Groups Projects
README.md 978 B
Newer Older
Claire Levy's avatar
Claire Levy committed
# User guide
This project contains the source files (rst format) allowing to build the [html files for NEMO User's guide](https://sites.nemo-ocean.io/user-guide/)

If you want to make some changes and updates, you can edit the rst source files in this directory.

The User guide is web-based and is automatically generated from rst files, [namelists and gallery](https://forge.nemo-ocean.eu/nemo/doc). 

Once the changes committed in these 3 projects, one needs to update their links into the project at the top of it [https://forge.nemo-ocean.eu/sites/user-guide](https://forge.nemo-ocean.eu/sites/user-guide), which in turn will trigger the Continuous Integration rebuilding the html files. 
[This project at the top](https://forge.nemo-ocean.eu/sites/user-guide) is for now available to NEMO Officers only, so that you need to contact your NEMO  Officer to [finalise the update and rebuild the html files](https://forge.nemo-ocean.eu/sites/user-guide/-/blob/main/README.md)
NEMO Ocean's avatar
NEMO Ocean committed