Deploy to GitHub pages

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 5f294d9e690338c9631d7c9174ec8464
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/cpp/dictionary_compiler.rst.txt

@@ -0,0 +1,6 @@
+DictionaryCompiler
+============================================
+
+.. doxygenclass:: keyvi::dictionary::DictionaryCompiler
+   :project: doxygen_keyvi
+   :members:

_sources/cpp/index.rst.txt

@@ -0,0 +1,6 @@
+Index
+=====
+
+.. doxygenclass:: keyvi::index::Index
+   :project: doxygen_keyvi
+   :members:

_sources/index.rst.txt

@@ -0,0 +1,33 @@
+.. keyvi documentation master file
+
+Welcome to keyvi!
+=================
+
+Keyvi - the short form for "Key value index" is a key value store (KVS) optimized for size and lookup speed. The usage 
+of shared memory makes it scalable and resistant. The biggest difference to other stores is the underlying data 
+structure based on `finite state machine <https://en.wikipedia.org/wiki/Finite-state_machine>`_. Storage is very space 
+efficient, fast and by design makes various sorts of approximate matching be it fuzzy string matching or geo highly 
+efficient. The immutable FST data structure can be used stand-alone for static datasets. If you need online writes, 
+you can use keyvi index, a "near realtime index". The index can be used as embedded key value store, e.g. if you 
+already have a network stack in your application. A out of the box network enabled store is available with 
+`keyvi-server <https://github.com/KeyviDev/keyvi-server>`_.
+
+The core of keyvi is written in C++, binding are available for Rust and Python.
+
+
+API Documentation
+=================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: C++ API
+
+   cpp/dictionary_compiler
+   cpp/index
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Python API
+
+   python/dictionary
+   python/index

_sources/python/dictionary.rst.txt

@@ -0,0 +1,14 @@
+Dictionary
+============================================
+
+The Dictionary provides read access to a singkle keyvi file.
+
+.. code-block:: python
+
+   from keyvi.dictionary import Dictionary
+
+   d=Dictionary("data.kv")
+
+
+.. autoclass:: keyvi.dictionary.Dictionary
+   :members:

_sources/python/index.rst.txt

@@ -0,0 +1,24 @@
+Index
+=====
+
+An index is a near-realtime updateable data structure with full CRUD functionality.
+
+
+.. code-block:: python
+
+   from keyvi.index import Index
+   from keyvi.index import ReadOnlyIndex
+
+   index = Index("/tmp/index-directory")
+   index.Set("a", "{'b': 3}")
+   index.Flush()
+
+   ri = ReadOnlyIndex("/tmp/index-directory")
+
+
+.. autoclass:: keyvi.index.Index
+   :members:
+
+
+.. autoclass:: keyvi.index.ReadOnlyIndex
+   :members: