Context Navigation

Changeset 14456

Timestamp:

2021-02-15T22:43:41+01:00 (3 years ago)

Author:

nicolasmartin

Message:

Fix documentation generation (manual and guide)

Location:

NEMO/releases/release-4.0.1

Files:

-                      r11698
+                      r14456
    This particular version has its own branch and can be checked out and downloaded with:
    .. code:: console
+   .. code-block:: console
       $ svn co https://forge.ipsl.jussieu.fr/ioserver/svn/XIOS/branchs/xios-2.5
 …
 =============================
 .. code:: console
+.. code-block:: console
    $ svn co https://forge.ipsl.jussieu.fr/nemo/svn/NEMO/releases/release-4.0.1

-                      r10991
+                      r14456
 :Release:  |release|
 :Date:     |today|
+:Date:     Oct. 2019
 :SVN rev.: |revision|
 …
   (``./src/TOP``)
 These physical core engines are described in their respective `references`_ that
+These physical core engines are described in their respective `references <#project-documentation>`_ that
 must be cited for any work related to their use.
 …
 - Opportunity to integrate an :doc:`external biogeochemistry model<tracers>`
 - Versatile :doc:`data assimilation<data_assimilation>`
 - Generation of :doc:`diagnostics<diagnostics>` through effective XIOS_ system
+- Generation of :doc:`diagnostics<diagnostics>` through effective :xios:`XIOS system<>`
 - Roll-out Earth system modeling with :doc:`coupling interface<coupling>` based on OASIS_

-                      r11693
+                      r14456
 \documentclass[../main/NEMO_manual]{subfiles}
-%% Local cmds
-\newcommand{\rML}[1][i]{\ensuremath{_{\mathrm{ML}\,#1}}}
-\newcommand{\rMLt}[1][i]{\tilde{r}_{\mathrm{ML}\,#1}}
-%% Move to ../../global/new_cmds.tex to avoid error with \listoffigures
-%\newcommand{\triad}[6][]{\ensuremath{{}_{#2}^{#3}{\mathbb{#4}_{#1}}_{#5}^{\,#6}}
-\newcommand{\triadd}[5]{\ensuremath{{}_{#1}^{#2}{\mathbb{#3}}_{#4}^{\,#5}}}
-\newcommand{\triadt}[5]{\ensuremath{{}_{#1}^{#2}{\tilde{\mathbb{#3}}}_{#4}^{\,#5}}}
-\newcommand{\rtriad}[2][]{\ensuremath{\triad[#1]{i}{k}{#2}{i_p}{k_p}}}
-\newcommand{\rtriadt}[1]{\ensuremath{\triadt{i}{k}{#1}{i_p}{k_p}}}
 \begin{document}

r11693	r14456
1	1	\documentclass[../main/NEMO_manual]{subfiles}
2
3		~~%% Custom aliases~~
4		~~\newcommand{\cf}{\ensuremath{C\kern-0.14em f}}~~
5	2
6	3	\begin{document}

-                      r11694
+                      r14456
 \documentclass[../main/TOP_manual]{subfiles}
-\newcommand{\cd}{\mathrm{CO_2}}
-\newcommand{\Ct}{\mathrm{C_T}}
-\newcommand{\pacd}{\mathrm{p^a_{CO_2}}}
-\newcommand{\cq}{\mathrm{^{14}C}}
-\newcommand{\Dcq}{\Delta ^{14}\mathrm{C}}
-\newcommand{\Rq}{\mathrm{^{14}{R}}}
-\newcommand{\CODE}[1]{\textsc{#1}}
-%\newcommand{\CODE}[1]{\textcolor{black}{\textsc{#1}}\xspace}
 \begin{document}

-                      r11693
+                      r14456
 \newcommand{\orcid}[1]{\href{http://orcid.org/#1}{\textcolor{orcidcolor}\aiOrcidSquare}}
+%% Workaround for \listoffigures
+\DeclareRobustCommand{\triad}[6][]{\ensuremath{ {}_{#2}^{#3} { \mathbb{#4}_{#1} }_{#5}^{\,#6} }}
+%% Local cmds
+\newcommand{\cf}{\ensuremath{C\kern-0.14em f}}
+\newcommand{\rML}[1][i]{\ensuremath{_{\mathrm{ML}\,#1}}}
+\newcommand{\rMLt}[1][i]{\tilde{r}_{\mathrm{ML}\,#1}}
+\newcommand{\triad}[6][]{\ensuremath{{}_{#2}^{#3}{\mathbb{#4}_{#1}}_{#5}^{\,#6}}}
+\newcommand{\triadd}[5]{\ensuremath{{}_{#1}^{#2}{\mathbb{#3}}_{#4}^{\,#5}}}
+\newcommand{\triadt}[5]{\ensuremath{{}_{#1}^{#2}{\tilde{\mathbb{#3}}}_{#4}^{\,#5}}}
+\newcommand{\rtriad}[2][]{\ensuremath{\triad[#1]{i}{k}{#2}{i_p}{k_p}}}
+\newcommand{\rtriadt}[1]{\ensuremath{\triadt{i}{k}{#1}{i_p}{k_p}}}
+\newcommand{\cd}{\mathrm{CO_2}}
+\newcommand{\Ct}{\mathrm{C_T}}
+\newcommand{\pacd}{\mathrm{p^a_{CO_2}}}
+\newcommand{\cq}{\mathrm{^{14}C}}
+\newcommand{\Dcq}{\Delta ^{14}\mathrm{C}}
+\newcommand{\Rq}{\mathrm{^{14}{R}}}
+\newcommand{\CODE}[1]{\textsc{#1}}
+%\newcommand{\CODE}[1]{\textcolor{black}{\textsc{#1}}\xspace}
 %% New command for ToC

r14427	r14456
18	18	%% Issue with fontawesome pkg: path to FontAwesome.otf has to be hard-coded
19	19	\defaultfontfeatures{
20		Path = /~~usr/local/texlive/2019~~/texmf-dist/fonts/opentype/public/fontawesome/
	20	Path = /home/nicolas/.local/texlive/2020/texmf-dist/fonts/opentype/public/fontawesome/
21	21	}
22	22	\usepackage{academicons, fontawesome, newtxtext}

-                      r11687
+                      r14456
+}
-%% Temporary fix
-\def\set@curr@file#1{%
-  \begingroup
-    \escapechar\m@ne
-    \xdef\@curr@file{\expandafter\string\csname #1\endcsname}%
-  \endgroup
+}
-\def\quote@name#1{"\quote@@name#1\@gobble""}
-\def\quote@@name#1"{#1\quote@@name}
-\def\unquote@name#1{\quote@@name#1\@gobble"}
 \makeatother

-                      r11698
+                      r14456
 # Timestamping
+import datetime
+year = datetime.date.today().year
+copyright = '2008-' + str( year ) + ', NEMO Consortium'
+copyright = '2008-2019, NEMO Consortium'
 # Link aliases
 …
 revision = subprocess.check_output("svnversion").decode("utf-8")
 rst_prolog = '.. |revision| replace:: %s' % revision
+# Default language to highlight set to fortran
+highlight_language = 'fortran'

r10279	r14456
29	29	on/off-line oceanic tracers transport and biogeochemistry models
30	30
31		`XIOS`_
	31	:xios:`XIOS<>`
32	32	XML Input Output Server,
33	33	library dedicated to input/output management of climate code

r10549	r14456
209	209	sn_trcdta(1) = 'tracer_1_data' , -12 , 'TRC1' , .false. , .true. , 'yearly' , '' , '' , ''
210	210	rf_trfac(1) = 2.0
211		cn_dir = ~~“usr/work/model/inputdata/”~~
	211	cn_dir = 'usr/work/model/inputdata/'
212	212
213	213	Note that, the Lateral Open Boundaries conditions are applied on the segments defined for the physical core of NEMO

Note: See TracChangeset for help on using the changeset viewer.