Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
  • 22-user-guide-coverage-of-psyclone-based-source-code-processing
  • branch_4.2 protected
3 results
Blame History Permalink
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
README.md 1.32 KiB

NEMO User guide

This project contains the source files (rst format) allowing to build the html files for NEMO User's 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.

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 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