.. Brink documentation master file, created by
   sphinx-quickstart on Sat Nov 19 13:23:53 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Brink's documentation!
=================================

Brink is a framework to build real time web APIs in a simple and coherent manner.
It utilizes aiohttp_ and RethinkDB_ under the hood to provide realtime updates
for your data models.

Contents:

.. toctree::
   :maxdepth: 2

   getting_started
   ...

.. toctree::
   :maxdepth: 2
   :caption: Usage

   config
   urls
   handlers
   models
   ...

.. toctree::
   :maxdepth: 2
   :caption: Reference

   fields_ref
   models_ref
   decorators_ref
   ...

.. _aiohttp: http://aiohttp.readthedocs.io/
.. _RethinkDB: http://rethinkdb.com

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

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