New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
guide.rst in NEMO/trunk/doc/rst/source – NEMO

source: NEMO/trunk/doc/rst/source/guide.rst @ 11752

Last change on this file since 11752 was 11752, checked in by nicolasmartin, 4 years ago

Improve the view of todo items by adding the list in the TOC tree

File size: 965 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.. only:: draft
18
19   .. toctree::
20      :hidden:
21
22      todos
23
24.. toctree::
25   :hidden:
26   :caption: Getting started
27
28   install
29   cfgs
30   tests
31
32.. toctree::
33   :hidden:
34   :caption: Setup your configuration
35
36   setup
37   diags
38   tools
39
40.. toctree::
41   :hidden:
42   :caption: Advanced use
43
44   zooms
45   cplg
46   da
47   tracers
48
49.. toctree::
50   :hidden:
51   :caption: Miscellaneous
52
53   cite
54   contrib
55   changes
56   acro
57
58:Release:  |release|
59
60.. only:: draft
61
62   :*Date*:     |today|
63   :*SVN rev*:  |revision|
64
65.. include:: readme.rst
Note: See TracBrowser for help on using the repository browser.