Changeset 11713 for NEMO/trunk/doc/rst/source/global.rst

Timestamp:

2019-10-17T17:49:19+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Revamp TOP README and implement a TODO list
Review tracers.rst by adding snippets of source files
Add drafthtml target for Makefile related to draft building tag for sphinx-build to
display todo items at the top of the guide homepage

Misc:

• Use dedicated :file: role instead of ... for file or directory
• Update BibTeX entries of NEMO reference publications by using :title: role
• Dump of RELEASE_NOTES.rst
• New file todos.rst to list all items declared with todo directive
• Modify conf.py to add a conditional test for draft tag

File:

• NEMO/trunk/doc/rst/source/global.rst (modified) (2 diffs)

NEMO/trunk/doc/rst/source/global.rst

@@ -5 +5 @@
 .. role:: grey
 .. role:: greysup(sup)
-.. role: underline
-..   :class: underline
 
 .. Substitutions
 
-.. |NEMO-OCE| replace:: :blue:`NEMO-OCE (Ocean dynamics)`
-.. |NEMO-ICE| replace:: :grey:`NEMO-SI`\ :greysup:`3`\ :grey:`(Sea Ice)`
-.. |NEMO-MBG| replace:: :green:`NEMO-TOP/PISCES (Biogeochemistry)`
+.. |NEMO-OCE| replace::  :blue:`NEMO-OCE (Ocean dynamics)`
+.. |OCE|      replace::  :blue:`NEMO-OCE`
+.. |NEMO-ICE| replace::  :grey:`NEMO-SI`\ :greysup:`3`  :grey:`(Sea Ice)`
+.. |ICE|      replace::  :grey:`NEMO-SI`\ :greysup:`3`
+.. |NEMO-MBG| replace:: :green:`NEMO-TOP/PISCES (Tracers)`
+.. |MBG|      replace:: :green:`NEMO-TOP/PISCES`
 
 .. External links
@@ -37 +38 @@
 .. _EGU: http://www.egu.eu
 .. _Special Issue: https://www.geosci-model-dev.net/special_issue40.html
+.. _BFM man: https://cmcc-foundation.github.io/www.bfm-community.eu/files/bfm-nemo-manual_r1.0_201508.pdf
 
 .. DOI