source:
NEMO/trunk/doc/rst/source/guide.rst
@
11718
| Last change on this file since 11718 was 11718, checked in by nicolasmartin, 4 years ago | |
|---|---|
| File size: 928 bytes | |
| Line | |
|---|---|
| 1 | ################# |
| 2 | Quick 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 roles, substitutions and URL links for the guide. |
| 15 | It is loaded for each file with the 'rst_epilog' setting in 'conf.py' |
| 16 | |
| 17 | .. toctree:: |
| 18 | :hidden: |
| 19 | :caption: Getting started |
| 20 | |
| 21 | install |
| 22 | cfgs |
| 23 | tests |
| 24 | |
| 25 | .. toctree:: |
| 26 | :hidden: |
| 27 | :caption: Setup your configuration |
| 28 | |
| 29 | setup |
| 30 | dia |
| 31 | tools |
| 32 | |
| 33 | .. toctree:: |
| 34 | :hidden: |
| 35 | :caption: Advanced use |
| 36 | |
| 37 | zooms |
| 38 | cplg |
| 39 | da |
| 40 | tracers |
| 41 | |
| 42 | .. toctree:: |
| 43 | :hidden: |
| 44 | :caption: Miscellaneous |
| 45 | |
| 46 | cite |
| 47 | contrib |
| 48 | changes |
| 49 | acro |
| 50 | |
| 51 | :Release: |release| |
| 52 | |
| 53 | .. only:: draft |
| 54 | |
| 55 | :*Date*: |today| |
| 56 | :*SVN rev*: |revision| |
| 57 | |
| 58 | .. include:: todos.rst |
| 59 | |
| 60 | .. include:: readme.rst |
Note: See TracBrowser
for help on using the repository browser.
