HAPPI - Heuristic Access to Positions of Photon Instruments
===========================================================

Background
^^^^^^^^^^

Happi is a database-backed library that was originally created to hold
information about devices along SLAC's Linac Coherent Light Source beamline.
Though initially purpose-built, happi provides a framework for general indexing
of devices or *things* that correspond to Python objects.

Happi will help you index your objects, search through them, create them, and
provide relevant metadata based on the object type.

.. toctree::
   :maxdepth: 3
   :caption: Usage

   containers.rst
   client.rst
   cli.rst

.. toctree::
   :maxdepth: 3
   :caption: API Documentation

   api.rst

.. toctree::
   :maxdepth: 0
   :caption: Information

   releases.rst