Merge pull request #345 from huonw/python-docs

Fix minor documentation problem and regenerate Python documentation.

docs/_sources/api.rst.txt

@@ -9,6 +9,19 @@ function should be called first before calling any other method.
 
 .. autofunction:: nmslib.init
 
+
+.. class:: nmslib.DistType
+
+    .. attribute:: FLOAT
+    .. attribute:: DOUBLE
+    .. attribute:: INT
+
+.. class:: nmslib.DataType
+
+    .. attribute:: DENSE_VECTOR
+    .. attribute:: OBJECT_AS_STRING
+    .. attribute:: SPARSE_VECTOR
+
 nmslib.FloatIndex
 -----------------
 

docs/_sources/index.rst.txt

@@ -14,6 +14,7 @@ Contents:
 
     Quickstart <quickstart>
     API Reference <api>
+    Logging <logging>
 
 
 Indices and tables

docs/_sources/logging.rst.txt

@@ -0,0 +1,32 @@
+Configuring Logging for NMSLIB
+==============================
+
+This library logs to a Python logger named ``nmslib``. This lets
+you fully control the log messages produced by nmslib in Python.
+
+For instance, to log everything produced by nmslib to a default
+python logger:
+
+.. code-block:: python
+
+    # setup basic python logging
+    import logging
+    logging.basicConfig(level=logging.DEBUG)
+
+    # importing nmslib logs some debug messages on startup, that
+    # that will be output to the python log handler created above
+    import nmslib
+
+To quiet these messages you can just set the level for nmslib
+as appropiate:
+
+.. code-block:: python
+
+    # setup basic python logging
+    import logging
+    logging.basicConfig(level=logging.DEBUG)
+
+    # Only log WARNING messages and above from nmslib
+    logging.getLogger('nmslib').setLevel(logging.WARNING)
+
+    import nmslib

docs/_static/basic.css

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -82,9 +82,21 @@ div.sphinxsidebar input {
 }
 
 div.sphinxsidebar #searchbox input[type="text"] {
-    width: 170px;
+    float: left;
+    width: 80%;
+    padding: 0.25em;
+    box-sizing: border-box;
+}
+
+div.sphinxsidebar #searchbox input[type="submit"] {
+    float: left;
+    width: 20%;
+    border-left: none;
+    padding: 0.25em;
+    box-sizing: border-box;
 }
 
+
 img {
     border: 0;
     max-width: 100%;
@@ -199,6 +211,11 @@ table.modindextable td {
 
 /* -- general body styles --------------------------------------------------- */
 
+div.body {
+    min-width: 450px;
+    max-width: 800px;
+}
+
 div.body p, div.body dd, div.body li, div.body blockquote {
     -moz-hyphens: auto;
     -ms-hyphens: auto;
@@ -332,6 +349,11 @@ table.docutils {
     border-collapse: collapse;
 }
 
+table.align-center {
+    margin-left: auto;
+    margin-right: auto;
+}
+
 table caption span.caption-number {
     font-style: italic;
 }
@@ -445,10 +467,14 @@ dd {
     margin-left: 30px;
 }
 
-dt:target, .highlighted {
+dt:target, span.highlighted {
     background-color: #fbe54e;
 }
 
+rect.highlighted {
+    fill: #fbe54e;
+}
+
 dl.glossary dt {
     font-weight: bold;
     font-size: 1.1em;