source:
NEMO/trunk/doc/rst/source/NEMO_guide.rst
@
10201
Last change on this file since 10201 was 10201, checked in by nicolasmartin, 6 years ago | |
---|---|
File size: 985 bytes |
Rev | Line | |
---|---|---|
[10186] | 1 | .. NEMO documentation master file, created by |
2 | sphinx-quickstart on Tue Oct 9 18:14:01 2018. | |
3 | You can adapt this file completely to your liking, but it should at least | |
4 | contain the root `toctree` directive. | |
5 | ||
[10201] | 6 | ################# |
[10186] | 7 | Quick Start Guide |
[10201] | 8 | ################# |
[10186] | 9 | |
[10201] | 10 | .. |
11 | A hidden .global.rst should be included in every subfiles with `include` directive | |
12 | It contains a list of common URL links | |
13 | ||
14 | .. include:: .global.rst | |
15 | ||
16 | .. include:: readme.rst | |
17 | ||
18 | Summary | |
19 | ======= | |
20 | ||
[10186] | 21 | .. toctree:: |
22 | :maxdepth: 1 | |
23 | :titlesonly: | |
24 | ||
25 | release_notes.rst | |
26 | install.rst | |
27 | reference_configurations.rst | |
28 | test_cases.rst | |
29 | setup_configuration.rst | |
30 | interfacing_options.rst | |
[10201] | 31 | definitions.rst |
[10186] | 32 | |
[10201] | 33 | .. |
34 | For headings markup, this convention is recommended from Python’s Style Guide | |
35 | # with overline, for parts | |
36 | * with overline, for chapters | |
37 | =, for sections | |
38 | -, for subsections | |
39 | ^, for subsubsections | |
40 | ", for paragraphs | |
[10186] | 41 | |
[10201] | 42 | .. |
43 | Indices and tables | |
44 | ================== | |
45 | * :ref:`genindex` | |
46 | * :ref:`modindex` | |
47 | * :ref:`search` |
Note: See TracBrowser
for help on using the repository browser.