.. polymr documentation master file, created by
   sphinx-quickstart on Wed Feb 21 10:21:39 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Polymr API Documentation
========================


:Release: |version|
:Date: |today|	  

Welcome to the polymr docs!

Polymr is a lightweight and extensible search engine. Polymr has some
good features:

  * Implemented entirely in Python
  * Flexible: capable of storing its index locally on LevelDB,
    remotely on Redis and Postgres, and distributedly on Amazon Dynamo
  * Extensible, well-defined backend classes
  * Capable of batch and incremental indexing
  * Threadsafe searches


Guide
_____

The guide gives a brief introduction to using the polymr API for
indexing and searching small documents. Definitely read this first
before diving into the API reference.

.. toctree::
   :maxdepth: 1

   quickstart
   contributing



API Reference
_____________

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   record
   query
   storage
   score
   featurizers
   indexmodule
   util


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

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