source: NEMO/trunk/doc/rst/source/NEMO_guide.rst @ 10590

Last change on this file since 10590 was 10590, checked in by nicolasmartin, 19 months ago

Shrink sphinx conf file and publish CONTRIBUTING file

File size: 1.4 KB
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 common directives (roles, substitutions and URL links)
15   It is loaded for each file thanks to 'rst_epilog' setting in 'conf.py'
16
17.. toctree::
18   :hidden:
19
20   release_notes.rst
21
22.. toctree::
23   :hidden:
24   :caption: Getting started
25
26   install
27   configurations
28   test_cases
29
30.. toctree::
31   :hidden:
32   :caption: Setup your configuration
33
34   setup
35   diagnostics
36   tools
37
38.. toctree::
39   :hidden:
40   :caption: Advanced use
41
42   zooms
43   coupling
44   assimilation
45   tracers
46
47.. toctree::
48   :hidden:
49   :caption: Contributions are welcome!
50
51   contributing
52
53.. toctree::
54   :hidden:
55   :caption: Glossary
56
57   definitions
58
59.. include:: readme.rst
60
61.. Next headings markup acording to readme.rst
62
63Reference publications
64======================
65
66.. bibliography:: references.bib
67   :all:
68   :style: unsrt
69   :labelprefix: R
70
71Disclaimer
72==========
73
74The NEMO source code is freely available and distributed under CeCILL license
75(GNU GPL compatible - see ``./LICENSE``).
76
77You can use, modify and/or redistribute the software under its terms,
78but users are provided only with a limited warranty and the software's authors and
79the successive licensor's have only limited liability.
Note: See TracBrowser for help on using the repository browser.