source: NEMO/trunk/doc/rst/source/guide.rst @ 11761

Last change on this file since 11761 was 11761, checked in by nicolasmartin, 11 months ago

Create unpub folder for unpublished READMEs (displayed with make drafthtml)

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