#################
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:

.. 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
   mixed

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

   changes
   migration
   cite
   acro

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

   sette

.. toctree::
   :hidden:
   :caption: Developer-guide: Documentation
   
   contrib
   editguide

.. :Release:  |release|

.. figure:: _static/frothyuv.png
   :width: 220px
   :align: right

   ..

.. note::
   These pages are a practical guide explaining how to get started with NEMO and how to
   utilise some of the more advanced features. For more detailed descriptions of NEMO's
   scientific and numerical options, and how these are built into the code, please refer to
   the Reference manuals :doc:`here <cite>`

**This is the 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|