source: NEMO/trunk/doc/rst/source/NEMO_guide.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: 938 bytes
Line 
1#################
2Quick Start Guide
3#################
4
5..
6   For headings markup, this convention is recommended from Python’s Style Guide
7   # with overline, for parts
8   * with overline, for chapters
9   =, for sections
10   -, for subsections
11   ^, for subsubsections
12   ", for paragraphs
13
14   'global.rst' contains a list of roles, substitutions and URL links for the guide.
15   It is loaded for each file with the 'rst_epilog' setting in 'conf.py'
16
17.. toctree::
18   :hidden:
19   :caption: Getting started
20
21   install
22   configurations
23   test_cases
24
25.. toctree::
26   :hidden:
27   :caption: Setup your configuration
28
29   setup
30   diagnostics
31   tools
32
33.. toctree::
34   :hidden:
35   :caption: Advanced use
36
37   zooms
38   coupling
39   data_assimilation
40   tracers
41
42.. toctree::
43   :hidden:
44   :caption: Miscellaneous
45
46   citations
47   contributing
48   release_notes
49   glossary
50
51:Release:  |release|
52
53.. only:: draft
54
55   .. include:: todos.rst
56
57.. include:: readme.rst
Note: See TracBrowser for help on using the repository browser.