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 @ 13244

Last change on this file since 13244 was 13244, checked in by clevy, 4 years ago

Update rst files

File size: 1.1 KB
Line 
1#################
2Quick Start Guide
3#################
4
5.. For headings markup, this convention is recommended from Python’s Style Guide
6   # with overline, for parts
7   * with overline, for chapters
8   =, for sections
9   -, for subsections
10   ^, for subsubsections
11   ", for paragraphs
12
13   'global.rst' contains a list of roles, substitutions and URL links for the guide.
14   It is loaded for each file with the 'rst_epilog' setting in 'conf.py'
15
16.. toctree::
17   :hidden:
18.. todos::
19
20.. Only displayed with 'make drafthtml'
21
22.. toctree::
23   :hidden:
24   :caption: Unpublished READMEs
25   :glob:
26   :titlesonly:
27
28   unpub/*
29
30.. Only displayed with 'make drafthtml'
31
32.. toctree::
33   :hidden:
34   :caption: Getting started
35
36   install
37   cfgs
38   tests
39
40.. toctree::
41   :hidden:
42   :caption: Setup your configuration
43
44   setup
45   diags
46   tools
47
48.. toctree::
49   :hidden:
50   :caption: Advanced use
51
52   zooms
53   cplg
54   da
55   tracers
56
57.. toctree::
58   :hidden:
59   :caption: Miscellaneous
60
61   cite
62   contrib
63   changes
64   acro
65
66:Release:  |release|
67
68.. only:: draft
69
70   .. Only on draft
71
72   :*Date*:     |today|
73   :*SVN rev*:  |revision|
74
75.. include:: readme.rst
Note: See TracBrowser for help on using the repository browser.