.. blitzr documentation master file, created by
   sphinx-quickstart on Mon Feb 29 17:51:10 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. module:: blitzr

Welcome to blitzr's documentation!
==================================

.. automodule:: blitzr.client
    :undoc-members:

Blitzr client:
--------------

.. toctree::
   :maxdepth: 2

.. autoclass:: blitzr.client.BlitzrClient
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:

Search Generator:
-----------------

.. autoclass:: blitzr.client.SearchGenerator
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:

Exceptions:
-----------

.. autoclass:: blitzr.exceptions.ConfigurationException
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: blitzr.exceptions.NetworkException
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: blitzr.exceptions.ClientException
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: blitzr.exceptions.ServerException
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:


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

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