@@ -6,6 +6,8 @@ This repository collects NEMO documentation manuals in LaTeX format.
- TOP interface for passive tracers
- SI3 sea ice model
To generate the manual(s) PDF it is necessary to install the [LateX](https://www.latex-project.org/) typesetting system and the python package [pygments](https://pygments.org/).
## Cloning with submodules
This repository uses the `namelists` and `gallery` documentation projects as git `submodules`.
...
...
@@ -31,7 +33,8 @@ Probably the easiest is to go directly to the CI/CD pipeline tab (from the left
### Manual build
Regular contributors to the reference manuals are likely to maintain LaTex build environments on their local resources [ TODO: add description of LaTeX packages required to build manuals ]. The `manual_build.sh` script can be used to generate the PDF version of manual(s) in a local environment as follows:
Regular contributors to the reference manuals are likely to maintain LaTex build environments on their local resources.
The `manual_build.sh` script can be used to generate the PDF version of manual(s) in a local environment as follows:
```
./manual_build.sh [-c] [-p] [-r version ] manual_name