.. FPlaneServer documentation master file, created by
   sphinx-quickstart on Mon Sep 11 08:14:29 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to FPlaneServer: HETWISE FPlane retrieval server  documentation!
========================================================================

Version: |release|

``fplaneserver`` is a RESTFul API server to retrieve and update the
focal plane configuration files for the HETDEX Survey <http://hetdex.org>`_.

``fplaneserver`` supports at least python 3.4.

This documentation is also available on `fplaneserver.readthedocs.io
<https://fplaneserver.readthedocs.io>`_.

.. image:: https://readthedocs.org/projects/fplaneserver/badge/?version=latest
    :target: https://fplaneserver.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status


User documentation
------------------

.. toctree::
   :maxdepth: 2

   user
      
Admin documentation
-------------------

.. toctree::
   :maxdepth: 2

   install
   run
   scripts
   confvars


Developer documentation
-----------------------

.. toctree::
   :maxdepth: 2

   api
   contributions
   codedoc/index


About
-----

.. toctree::
    :maxdepth: 2

    authors
    license
    changelog
    todo
..    Coverage <../fplaneserver_cover>


Links
-----

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