Documentation update (#34)

* docs setup

* docs done

* review fixes

Author: Sherin Thomas

.gitignore

@@ -7,3 +7,4 @@ redisai.egg-info
 .mypy_cache/
 build/
 dist/
+docs/_build/

README.md

@@ -0,0 +1,47 @@
+==========
+redisai-py
+==========
+
+.. image:: https://img.shields.io/github/license/RedisAI/redisai-py.svg
+        :target: https://github.com/RedisAI/redisai-py
+
+.. image:: https://badge.fury.io/py/redisai.svg
+        :target: https://badge.fury.io/py/redisai
+
+.. image:: https://circleci.com/gh/RedisAI/redisai-py/tree/master.svg?style=svg
+        :target: https://circleci.com/gh/RedisAI/redisai-py/tree/master
+
+.. image:: https://img.shields.io/github/release/RedisAI/redisai-py.svg
+        :target: https://github.com/RedisAI/redisai-py/releases/latest
+
+.. image:: https://codecov.io/gh/RedisAI/redisai-py/branch/master/graph/badge.svg
+        :target: https://codecov.io/gh/RedisAI/redisai-py
+
+
+redisai-py is the Python client for RedisAI. Checkout the
+`documentation <https://redisai-py.readthedocs.io/en/latest/>`_ for API details and examples
+
+Installation
+------------
+
+1. Install Redis 5.0 or above
+2. Install `RedisAI <http://redisai.io>`_
+3. Install the Python client
+
+.. code-block:: bash
+
+    $ pip install redisai
+
+
+4. Install serialization-deserialization utility (optional)
+
+.. code-block:: bash
+
+    $ pip install ml2rt
+
+
+`RedisAI example repo <https://github.com/RedisAI/redisai-examples>`_ shows few examples
+made using redisai-py under `python_client` folder. Also, checkout
+`ml2rt <https://github.com/hhsecond/ml2rt>`_ for convenient functions those might help in
+converting models (sparkml, sklearn, xgboost to ONNX), serializing models to disk, loading
+it back to redisai-py etc.

README.rst

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/Makefile

@@ -0,0 +1,12 @@
+.. _ref-api:
+
+API Documentation
+=================
+This page hosts the documentation of all user-facing APIs. The only entrypoint the users
+should be using is the ``Client`` class. It exposes all the RedisAI commands as methods
+
+
+Client Class
+------------
+.. autoclass:: redisai.Client
+   :members:

docs/api.rst

@@ -0,0 +1,34 @@
+import redisai
+
+project = 'redisai-py'
+copyright = '2020, RedisLabs'
+author = 'RedisLabs'
+release = redisai.__version__
+extensions = ['sphinx.ext.autodoc',
+              'sphinx.ext.autosummary',
+              'sphinx.ext.extlinks',
+              'sphinx.ext.napoleon',
+              'sphinx.ext.todo',
+              'sphinx.ext.intersphinx',
+              "sphinx_rtd_theme"]
+templates_path = ['_templates']
+source_suffix = '.rst'
+master_doc = 'index'
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+html_theme = 'sphinx_rtd_theme'
+html_use_smartypants = True
+html_last_updated_fmt = '%b %d, %Y'
+html_split_index = False
+html_sidebars = {
+   '**': ['searchbox.html', 'globaltoc.html', 'sourcelink.html'],
+}
+html_short_title = '%s-%s' % (project, release)
+
+napoleon_use_ivar = True
+napoleon_use_rtype = True
+napoleon_use_param = True
+napoleon_include_init_with_doc = True
+
+add_module_names = False
+doctest_test_doctest_blocks = None
+autoclass_content = 'class'

docs/conf.py

@@ -0,0 +1,17 @@
+Welcome to redisai-py's documentation!
+======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   readme
+   api
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`