.. Kepler documentation master file, created by
   sphinx-quickstart on Wed May 20 22:57:33 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

===================================================
Kepler Server Application Source Code Documentation
===================================================

Software version 1.0.0
----------------------

Documentation version |version|
-------------------------------

Kepler is an application developed for Physics Department of University of
Jyväskylä. The application is designed to be used as lab reservation system
for the student laboratory of the department.

Kepler consists of the server side application (i.e. `back-end`), written in
Python, and the client-side application (i.e. `front-end`), written in
JavaScript. The back-end is documented in this document, while the front-end is
documented separately.

The communication between the back-end and the front-end of the Kepler
application happens through a REST API. The REST API, defined in the
:doc:`src/kepler.api`, is documented in the
:doc:`REST API documentation <src/kepler.rest.api>`.

The REST API documentation is dynamically generated by the kepler server
application and is accessible during run-time of the application through the
view defined by :py:meth:`kepler.api.api_doc.rest_api_view`.

Contents
========

.. toctree::
   :maxdepth: 4

   src/kepler

.. toctree::
   :maxdepth: 2

   src/kepler.rest.api

.. src/modules


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

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