.. Mule documentation master file, created by
   sphinx-quickstart on Thu Aug 27 13:47:54 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Mule's documentation
================================

About Mule
----------
Mule is an API written in Python which allows you to access and manipulate
files produced by the UM (Unified Model, of the Met Office (UK)).  

**Contents:**

Guides and Tutorials:

.. toctree::
   :maxdepth: 1

   user_guide
   examples

API Documentation:

.. toctree::
   :maxdepth: 1

   mule
   mule/ff
   mule/lbc
   mule/ancil
   mule/pp
   mule/packing
   mule/operators
   mule/stashmaster
   mule/validators

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`