.. YAK-server documentation master file, created by
   sphinx-quickstart on Thu Aug  4 15:18:19 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to YAK-server's documentation!
======================================

Adding YAK-server to your project
=================================

``pip install -e git://github.com/yeti/yak-server.git@master#egg=yak-server`` will install yak-server to your project.

Once you have installed yak-server, learn more about each of its modules and how to set them up:

Contents:

.. toctree::
   :maxdepth: 2

   yak.rest_core <rest_core/core_intro>
   yak.rest_user <rest_user/user_intro>
   yak.rest_social_auth <rest_social_auth/social_auth_intro>
   yak.rest_social_network <rest_social_network/social_network_intro>
   yak.rest_notifications <rest_notifications/notifications_intro>
   contributing



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

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