index.rst

#################
NEMO User Guide
#################

.. For headings markup, this convention is recommended from Python’s Style Guide
   # with overline, for parts
   * with overline, for chapters
   =, for sections
   -, for subsections
   ^, for subsubsections
   ", for paragraphs

   'global.rst' contains a list of roles, substitutions and URL links for the guide.
   It is loaded for each file with the 'rst_epilog' setting in 'conf.py'

.. toctree::
   :hidden:

.. todos

.. Only displayed with 'make drafthtml'

.. toctree::
   :hidden:
   :caption: Unpublished READMEs
   :glob:
   :titlesonly:

#   unpub/*

.. Only displayed with 'make drafthtml'

.. toctree::
   :hidden:
   :caption: User-guide: Basics

   install
   cfgs
   tests

.. toctree::
   :hidden:
   :caption: User-guide: Advanced
 
   zooms
   cplg
   da
   tracers
   setup
   diags
   tools

.. toctree::
   :hidden:
   :caption: User-guide: Appendix

   changes
   migration
   cite
   contrib
   acro

.. toctree::
   :hidden:
   :caption: Developer-guide: testing

   sette

.. :Release:  |release|

.. note::
   Important foreword: this document is a "How to" explaining how to get started with NEMO. For detailed description of NEMO functionalities and how these are build in the code, please refer to the Reference manuals :doc:`here <cite>`

This User's guide for NEMO version: |release|. Use the sidebar links for navigation or start :doc:`here <install>`

..    :*Date*: Last updated: |today|

Last updated: |today|

.. only:: draft

   .. Only on draft

   :*Date*:     |today|