Ignore:
Timestamp:
2018-11-07T12:04:15+01:00 (2 years ago)
Author:
nicolasmartin
Message:

Various improvments for quick start guide

  • implementation of Rtd theme (Read the Docs) with custom layout and style file
  • add reviewed BibTeX entries for NEMO references with DOI (manuals, guide, development strategy)
  • enhancement of bibliography management and configuration file for guide building
  • standardisation of headings markup
  • numerous edits
File:
1 edited

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/doc/rst/source/NEMO_guide.rst

    r10201 r10279  
    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  
    61################# 
    72Quick Start Guide 
     
    94 
    105.. 
    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  
    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 
     6   For headings markup, this convention is recommended from Python’s Style Guide 
    357   # with overline, for parts 
    368   * with overline, for chapters 
     
    4012   ", for paragraphs 
    4113 
    42 .. 
    43    Indices and tables 
    44    ================== 
    45    * :ref:`genindex` 
    46    * :ref:`modindex` 
    47    * :ref:`search` 
     14   'global.rst' contains a list of common directives (roles, substitutions and URL links) 
     15   It is loaded for each file thanks to 'rst_epilog' setting in 'conf.py' 
     16 
     17.. toctree:: 
     18   :hidden: 
     19 
     20   release_notes.rst 
     21 
     22.. toctree:: 
     23   :hidden: 
     24   :caption: Getting started 
     25 
     26   install 
     27   configurations 
     28   test_cases 
     29 
     30.. toctree:: 
     31   :hidden: 
     32   :caption: Setup your configuration 
     33 
     34   setup 
     35   diagnostics 
     36   tools 
     37 
     38.. toctree:: 
     39   :hidden: 
     40   :caption: Advanced use 
     41 
     42   zooms 
     43   coarsening 
     44   coupling 
     45   assimilation 
     46   tracers 
     47 
     48.. toctree:: 
     49   :hidden: 
     50   :caption: Glossary 
     51 
     52   definitions 
     53 
     54.. include:: readme.rst 
     55 
     56.. Next headings markup acording to readme.rst 
     57 
     58How to cite NEMO 
     59================ 
     60 
     61.. bibliography:: references.bib 
     62   :all: 
     63   :style: unsrt 
     64   :labelprefix: R 
     65 
     66Disclaimer 
     67========== 
     68 
     69The NEMO source code is freely available and distributed under CeCILL license 
     70(GNU GPL compatible - see ``./LICENSE``). 
     71 
     72You can use, modify and/or redistribute the software under its terms, 
     73but users are provided only with a limited warranty and the software's authors and 
     74the successive licensor's have only limited liability. 
Note: See TracChangeset for help on using the changeset viewer.