Skip to content
Snippets Groups Projects
Normal view History Permalink
README.rst 877 B
Newer Older
Tomas Lovato's avatar
import documentation from nemo main code at commit d1c6ae27
Tomas Lovato committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 
**************************
NEMO manuals
**************************



**************************
Building the documentation
**************************

Usage:
------
./manual_build.sh [-p] [-r version ] manual
Mandatory
          Chose one model manual among NEMO SI3 TOP or all (if not provided compile "NEMO")
Optional
   -p     Produce manual with figures and disable draft watermark
   -r     Specify the release version number of the manual(s) instead of the branch name



:file:`latex`    : LaTeX sources and Latexmk configuration to build reference manuals with :file:`manual_build.sh`

:file:`namelists`: Namelist blocks included in the documentation

:file:`rst`      : |RST man|_ sources and Sphinx configuration to build this guide hereby with :file:`guide_build.sh`

.. |RST man| replace:: reStructuredText (rst)

.. warning::

    Mention `svnignore` hidden file