source:
NEMO/trunk/doc/rst/source/guide.rst
@
11734
Last change on this file since 11734 was 11734, checked in by nicolasmartin, 5 years ago | |
---|---|
File size: 930 bytes |
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 | |
[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 | |
17 | .. toctree:: | |
[10600] | 18 | :hidden: |
19 | :caption: Getting started | |
[10279] | 20 | |
[10600] | 21 | install |
[11718] | 22 | cfgs |
23 | tests | |
[10279] | 24 | |
25 | .. toctree:: | |
[10600] | 26 | :hidden: |
27 | :caption: Setup your configuration | |
[10279] | 28 | |
[10600] | 29 | setup |
[11734] | 30 | diags |
[10600] | 31 | tools |
[10279] | 32 | |
33 | .. toctree:: | |
[10600] | 34 | :hidden: |
35 | :caption: Advanced use | |
[10279] | 36 | |
[10600] | 37 | zooms |
[11718] | 38 | cplg |
39 | da | |
[10600] | 40 | tracers |
[10279] | 41 | |
42 | .. toctree:: | |
[10600] | 43 | :hidden: |
[10602] | 44 | :caption: Miscellaneous |
[10590] | 45 | |
[11718] | 46 | cite |
47 | contrib | |
48 | changes | |
49 | acro | |
[10590] | 50 | |
[11713] | 51 | :Release: |release| |
[10279] | 52 | |
[11713] | 53 | .. only:: draft |
[10279] | 54 | |
[11718] | 55 | :*Date*: |today| |
56 | :*SVN rev*: |revision| | |
57 | ||
[11713] | 58 | .. include:: todos.rst |
[10279] | 59 | |
[11713] | 60 | .. include:: readme.rst |
Note: See TracBrowser
for help on using the repository browser.