add sphinx-style docs with installation + quickstart

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = genesis-client
+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)

doc/_static/css/my_theme.css

@@ -0,0 +1,29 @@
+/* Uses skorch docs theme from https://skorch.readthedocs.io */
+
+.wy-side-nav-search {
+	background-color: #fcfcfc;
+}
+
+.wy-side-nav-search > div.version {
+	color: black;
+}
+
+.wy-side-nav-search > a {
+	color: black;
+}
+
+/* Adds logo in header for mobile */
+
+.wy-nav-top {
+	background-color: #fcfcfc;
+	#background-image: url('../logo.png');
+	background-repeat: no-repeat;
+	background-position: bottom;
+	padding: 0;
+	margin: 0.4045em 0.809em;
+	color: #333;
+}
+
+.wy-nav-top > a {
+	display: none;
+}

doc/_templates/layout.html

@@ -0,0 +1,2 @@
+{# {%- set logo = "logo.png" %} #}
+{% extends "!layout.html" %}

doc/api/api.rst

@@ -0,0 +1,9 @@
+.. _api:
+
+genesis-client API
+##################
+
+.. toctree::
+    :maxdepth: 2
+
+    streaming

doc/api/streaming.rst

@@ -0,0 +1,7 @@
+.. _streaming:
+
+genesis.streaming
+#####################
+
+.. automodule:: genesis.streaming
+    :members:

doc/conf.py

@@ -0,0 +1,176 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
+
+#  on_rtd is whether we are on readthedocs.org, this line of code grabbed
+#  from docs.readthedocs.org
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+# -- Project information -----------------------------------------------------
+
+project = u'genesis-client'
+copyright = u'2019, Mario Juric'
+author = u'Mario Juric'
+
+# The short X.Y version
+version = u''
+# The full version, including alpha/beta/rc tags
+release = u''
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.coverage',
+    'sphinx.ext.graphviz',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.autosectionlabel',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = ['_build']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+def setup(app):
+    app.add_stylesheet('css/my_theme.css')
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+if not on_rtd:  # only import and set the theme if we're building docs locally
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+#html_sidebars = { '**': ['about.html', 'navigation.html', 'relations.html', 'searchbox.html'] }
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'genesis-clientdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'genesis-client.tex', u'genesis-client Documentation',
+     u'Mario Juric', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'genesis-client', u'genesis-client Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'genesis-client', u'genesis-client Documentation',
+     author, 'genesis-client', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------

doc/index.rst

@@ -0,0 +1,26 @@
+genesis-client documentation
+============================
+
+User's Guide
+------------
+
+.. toctree::
+   :maxdepth: 2
+
+   user/installation
+   user/quickstart
+
+API Reference
+-------------
+
+.. toctree::
+   :maxdepth: 2
+
+   api/api
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/user/installation.rst

@@ -0,0 +1,29 @@
+============
+Installation
+============
+
+.. contents::
+   :local:
+
+You can install genesis-client either via pip, conda, or from source.
+
+To install with pip:
+
+.. code:: bash
+
+   pip install adc
+
+
+To install with conda, you must use the channel from the SCiMMA Anaconda organization:
+
+.. code:: bash
+
+    conda install --channel scimma adc
+
+To install from source:
+
+.. code:: bash
+
+    tar -xzf adc-x.y.z.tar.gz
+    cd adc-x.y.z
+    python setup.py install

doc/user/quickstart.rst

@@ -0,0 +1,25 @@
+==========
+Quickstart
+==========
+
+.. contents::
+   :local:
+
+Reading messages:
+
+.. code:: bash
+
+    import genesis.streaming as gs
+
+    with gs.open("kafka://bootstrap.server/topic", "r", format="json") as stream:
+        for idx, msg in stream:
+            print(f"id: {idx}, contents: {msg}")
+
+Writing messages:
+
+.. code:: bash
+
+    import genesis.streaming as gs
+
+    with gs.open("kafka://bootstrap.server/topic", "w", format="json") as stream:
+        stream.write({"contents": "hello"})