New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
Changeset 10201 for NEMO/trunk/doc/rst/source/NEMO_guide.rst – NEMO

Ignore:
Timestamp:
2018-10-18T12:53:04+02:00 (6 years ago)
Author:
nicolasmartin
Message:

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:
1 edited

Legend:

Unmodified
Added
Removed

  • NEMO/trunk/doc/rst/source/NEMO_guide.rst

    r10186 r10201  
    44   contain the root `toctree` directive. 
    55 
    6 ================= 
     6################# 
    77Quick Start Guide 
    8 ================= 
     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======= 
    920 
    1021.. toctree:: 
    … …  
    1829   setup_configuration.rst 
    1930   interfacing_options.rst 
    20    references.rst 
     31   definitions.rst 
    2132 
    22 .. include:: readme.rst 
     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 
    2341 
    24 Indices and tables 
    25 ================== 
    26  
    27 * :ref:`genindex` 
    28 * :ref:`modindex` 
    29 * :ref:`search` 
     42.. 
     43   Indices and tables 
     44   ================== 
     45   * :ref:`genindex` 
     46   * :ref:`modindex` 
     47   * :ref:`search` 
Note: See TracChangeset for help on using the changeset viewer.