source: NEMO/trunk/doc/rst/source/NEMO_guide.rst @ 10201

Last change on this file since 10201 was 10201, checked in by nicolasmartin, 2 years ago

Various modifications related to the setting of a NEMO Quick Start Guide

  • Add missing namelist blocks from ICE and TOP
  • Create a hidden .global.rst to gather common URL links
  • Convert animated gif to frames images for PDF export
  • Place different README.rst appropriately in the code structure and refer to them with symbolic links in doc/rst/source
File size: 985 bytes
Line 
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
6#################
7Quick Start Guide
8#################
9
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
18Summary
19=======
20
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
31   definitions.rst
32
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
41
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.