source: NEMO/trunk/doc/rst/source/global.rst @ 11713

Last change on this file since 11713 was 11713, checked in by nicolasmartin, 2 years ago

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 size: 2.0 KB
Line 
1.. Roles (custom styles related to CSS classes in 'source/_static/style.css')
2
3.. role:: blue
4.. role:: green
5.. role:: grey
6.. role:: greysup(sup)
7
8.. Substitutions
9
10.. |NEMO-OCE| replace::  :blue:`NEMO-OCE (Ocean dynamics)`
11.. |OCE|      replace::  :blue:`NEMO-OCE`
12.. |NEMO-ICE| replace::  :grey:`NEMO-SI`\ :greysup:`3`  :grey:`(Sea Ice)`
13.. |ICE|      replace::  :grey:`NEMO-SI`\ :greysup:`3`
14.. |NEMO-MBG| replace:: :green:`NEMO-TOP/PISCES (Tracers)`
15.. |MBG|      replace:: :green:`NEMO-TOP/PISCES`
16
17.. External links
18
19   .. Consortium institutes
20
21.. _CMCC:       https://www.cmcc.it
22.. _CNRS:       https://www.cnrs.fr
23.. _Met Office: https://www.metoffice.gov.uk
24.. _MOI:        https://www.mercator-ocean.fr
25.. _NERC:       https://nerc.ukri.org
26
27   .. Models / Libraries / Dependencies
28
29.. _AGRIF:  http://agrif.imag.fr
30.. _FCM:    https://metomi.github.io/fcm
31.. _IOIPSL: https://forge.ipsl.jussieu.fr/igcmg/browser/IOIPSL
32.. _NEMO:   https://www.nemo-ocean.eu
33.. _OASIS:  https://portal.enes.org/oasis
34.. _XIOS:   https://forge.ipsl.jussieu.fr/ioserver
35
36   .. Misc.
37
38.. _EGU: http://www.egu.eu
39.. _Special Issue: https://www.geosci-model-dev.net/special_issue40.html
40.. _BFM man: https://cmcc-foundation.github.io/www.bfm-community.eu/files/bfm-nemo-manual_r1.0_201508.pdf
41
42.. DOI
43
44   .. Publications (`:samp:` to deactivate link for unpublished documents)
45
46.. _DOI man   OCE:        https://doi.org/10.5281/zenodo.1464816
47.. _DOI man   ICE: :samp: https://doi.org/10.5281/zenodo.1471689
48.. _DOI man   MBG: :samp: https://doi.org/10.5281/zenodo.1471700
49.. _DOI strt  gui: :samp: https://doi.org/10.5281/zenodo.1475325
50.. _DOI dev  stgy:        https://doi.org/10.5281/zenodo.1471663
51
52   .. Badges (same labels as previously, substitution to link images)
53
54.. |DOI man   OCE| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1464816.svg
55.. |DOI man   ICE| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1471689.svg
56.. |DOI man   MBG| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1471700.svg
57.. |DOI strt  gui| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1475325.svg
Note: See TracBrowser for help on using the repository browser.