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, 5 years ago

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

File size: 965 bytes
RevLine 
[10201]1#################
[10186]2Quick Start Guide
[10201]3#################
[10186]4
[10201]5..
[10279]6   For headings markup, this convention is recommended from Python’s Style Guide
[10201]7   # with overline, for parts
8   * with overline, for chapters
9   =, for sections
10   -, for subsections
11   ^, for subsubsections
12   ", for paragraphs
[10186]13
[11713]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'
[10279]16
[11752]17.. only:: draft
18
19   .. toctree::
20      :hidden:
21
22      todos
23
[10279]24.. toctree::
[10600]25   :hidden:
26   :caption: Getting started
[10279]27
[10600]28   install
[11718]29   cfgs
30   tests
[10279]31
32.. toctree::
[10600]33   :hidden:
34   :caption: Setup your configuration
[10279]35
[10600]36   setup
[11734]37   diags
[10600]38   tools
[10279]39
40.. toctree::
[10600]41   :hidden:
42   :caption: Advanced use
[10279]43
[10600]44   zooms
[11718]45   cplg
46   da
[10600]47   tracers
[10279]48
49.. toctree::
[10600]50   :hidden:
[10602]51   :caption: Miscellaneous
[10590]52
[11718]53   cite
54   contrib
55   changes
56   acro
[10590]57
[11713]58:Release:  |release|
[10279]59
[11713]60.. only:: draft
[10279]61
[11718]62   :*Date*:     |today|
63   :*SVN rev*:  |revision|
64
[11713]65.. include:: readme.rst
Note: See TracBrowser for help on using the repository browser.