source:
NEMO/trunk/doc/rst/source/NEMO_guide.rst
@
11003
Last change on this file since 11003 was 10602, checked in by nicolasmartin, 5 years ago | |
---|---|
File size: 1.3 KB |
Rev | Line | |
---|---|---|
[10201] | 1 | ################# |
[10186] | 2 | Quick 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 | |
[10279] | 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:: | |
[10600] | 18 | :hidden: |
19 | :caption: Getting started | |
[10279] | 20 | |
[10600] | 21 | install |
22 | configurations | |
23 | test_cases | |
[10279] | 24 | |
25 | .. toctree:: | |
[10600] | 26 | :hidden: |
27 | :caption: Setup your configuration | |
[10279] | 28 | |
[10600] | 29 | setup |
30 | diagnostics | |
31 | tools | |
[10279] | 32 | |
33 | .. toctree:: | |
[10600] | 34 | :hidden: |
35 | :caption: Advanced use | |
[10279] | 36 | |
[10600] | 37 | zooms |
38 | coupling | |
39 | data_assimilation | |
40 | tracers | |
[10279] | 41 | |
42 | .. toctree:: | |
[10600] | 43 | :hidden: |
[10602] | 44 | :caption: Miscellaneous |
[10590] | 45 | |
[10600] | 46 | contributing |
[10602] | 47 | release_notes |
48 | Glossary<definitions> | |
[10590] | 49 | |
[10279] | 50 | .. include:: readme.rst |
51 | ||
52 | .. Next headings markup acording to readme.rst | |
53 | ||
[10602] | 54 | References |
55 | ========== | |
[10279] | 56 | |
[10600] | 57 | .. bibliography:: references.bib |
58 | :all: | |
59 | :style: unsrt | |
60 | :labelprefix: R | |
[10279] | 61 | |
62 | Disclaimer | |
63 | ========== | |
64 | ||
65 | The NEMO source code is freely available and distributed under CeCILL license | |
66 | (GNU GPL compatible - see ``./LICENSE``). | |
67 | ||
68 | You can use, modify and/or redistribute the software under its terms, | |
69 | but users are provided only with a limited warranty and the software's authors and | |
70 | the successive licensor's have only limited liability. |
Note: See TracBrowser
for help on using the repository browser.