diff --git a/README.md b/README.md index 72bda90f3a17b87ed3a1571887687a551322ac3c..09ab326f7b985409d01affda9a519943038dd1ea 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,28 @@ -# User guide +## NEMO 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. + +## Cloning with submodules + +This repository uses the `namelists` and `gallery` documentation projects as git `submodules`. + +So when cloning this repository it is necessary to clone also the related submodules, using the following command + +`git clone --recurse-submodules <reponame>` + +If the repository was cloned in a standard way, it is possible to checkout submodules using + +`git submodule update --init ` + + +## Update the online documentation + +Once that requested changes are committed to one or all these 3 projects, it is necessary to update their links into this project 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) diff --git a/environment.yml b/environment.yml new file mode 100644 index 0000000000000000000000000000000000000000..6a3936cba310c28412f1ce4aa0381eb3199daa58 --- /dev/null +++ b/environment.yml @@ -0,0 +1,15 @@ +--- +name: nemo-user-guide +channels: + - conda-forge + +dependencies: + # Multi language support: + - python>=3.8 + - sphinx + - sphinxcontrib-bibtex + - sphinx_rtd_theme + - pip + # regular pip packages + - pip: + - sphinxext-remoteliteralinclude