source:
NEMO/trunk/doc/rst/source/guide.rst
@
14291
Last change on this file since 14291 was 13244, checked in by clevy, 4 years ago | |
---|---|
File size: 1.1 KB |
Rev | Line | |
---|---|---|
[10201] | 1 | ################# |
[10186] | 2 | Quick Start Guide |
[10201] | 3 | ################# |
[10186] | 4 | |
[11761] | 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 | |
[10186] | 12 | |
[11761] | 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' | |
[10279] | 15 | |
[11761] | 16 | .. toctree:: |
17 | :hidden: | |
[13244] | 18 | .. todos:: |
[11752] | 19 | |
[11761] | 20 | .. Only displayed with 'make drafthtml' |
[11752] | 21 | |
[10279] | 22 | .. toctree:: |
[10600] | 23 | :hidden: |
[11761] | 24 | :caption: Unpublished READMEs |
25 | :glob: | |
26 | :titlesonly: | |
27 | ||
28 | unpub/* | |
29 | ||
30 | .. Only displayed with 'make drafthtml' | |
31 | ||
32 | .. toctree:: | |
33 | :hidden: | |
[10600] | 34 | :caption: Getting started |
[10279] | 35 | |
[10600] | 36 | install |
[11718] | 37 | cfgs |
38 | tests | |
[10279] | 39 | |
40 | .. toctree:: | |
[10600] | 41 | :hidden: |
42 | :caption: Setup your configuration | |
[10279] | 43 | |
[10600] | 44 | setup |
[11734] | 45 | diags |
[10600] | 46 | tools |
[10279] | 47 | |
48 | .. toctree:: | |
[10600] | 49 | :hidden: |
50 | :caption: Advanced use | |
[10279] | 51 | |
[10600] | 52 | zooms |
[11718] | 53 | cplg |
54 | da | |
[10600] | 55 | tracers |
[10279] | 56 | |
57 | .. toctree:: | |
[10600] | 58 | :hidden: |
[10602] | 59 | :caption: Miscellaneous |
[10590] | 60 | |
[11718] | 61 | cite |
62 | contrib | |
63 | changes | |
64 | acro | |
[10590] | 65 | |
[11713] | 66 | :Release: |release| |
[10279] | 67 | |
[11713] | 68 | .. only:: draft |
[10279] | 69 | |
[11761] | 70 | .. Only on draft |
71 | ||
[11718] | 72 | :*Date*: |today| |
73 | :*SVN rev*: |revision| | |
74 | ||
[11713] | 75 | .. include:: readme.rst |
Note: See TracBrowser
for help on using the repository browser.