.. HyperSpy documentation master file, created by
   sphinx-quickstart on Mon Oct 18 11:10:55 2010.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. _user_guide-label:

Welcome to HyperSpy's documentation!
====================================

.. toctree::
   :maxdepth: 1
   :caption: User Guide

   user_guide/intro.rst
   user_guide/changes.rst
   user_guide/install.rst
   user_guide/getting_started.rst
   user_guide/signal.rst
   user_guide/axes.rst
   user_guide/interactive_operations_ROIs.rst
   user_guide/signal1d.rst
   user_guide/signal2d.rst
   user_guide/visualisation.rst
   user_guide/mva.rst
   user_guide/model.rst
   user_guide/eels.rst
   user_guide/eds.rst
   user_guide/dielectric_function.rst
   user_guide/electron_holography.rst
   user_guide/io.rst
   user_guide/events.rst
   user_guide/big_data.rst
   user_guide/metadata_structure.rst
   user_guide/bibliography.rst

.. toctree::
   :maxdepth: 1
   :caption: Developer Guide

   dev_guide/intro.rst
   dev_guide/git.rst
   dev_guide/testing.rst
   dev_guide/writing_docs.rst
   dev_guide/coding_style.rst
   dev_guide/lazy_computations.rst
   dev_guide/speeding_up_code.rst
   dev_guide/writing_extensions.rst
   dev_guide/useful_information.rst

.. toctree::
   :maxdepth: 2
   :caption: API References

   api/modules.rst

.. toctree::
   :maxdepth: 1
   :caption: Credits and citation

   credits.rst
   citing.rst


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

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

