feat(docs) Start Sphinx docs (#74)

Adds the boilerplate for the Sphinx docs for this library and adds a basic intro.

Makefile

@@ -13,3 +13,7 @@ lint:
 
 tests:
 	pytest -vv
+
+docs:
+	pip install -U -r ./docs-requirements.txt
+	sphinx-build -W -b html docs/source docs/build

docs-requirements.txt

@@ -0,0 +1 @@
+sphinx==5.0.0

docs/.gitignore

@@ -0,0 +1 @@
+build/*

docs/source/conf.py

@@ -0,0 +1,35 @@
+# Configuration file for the Sphinx documentation builder.
+#
+
+# -- Project information -----------------------------------------------------
+
+project = "Arroyo"
+copyright = "2022, Sentry Team and Contributors"
+author = "Sentry Team and Contributors"
+
+release = "0.0.20"
+
+
+# -- General configuration ---------------------------------------------------
+
+extensions = [
+    "sphinx.ext.githubpages",
+    "sphinx.ext.intersphinx",
+]
+
+# This is relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ["build"]
+
+source_suffix = ".rst"
+
+# -- Options for HTML output -------------------------------------------------
+
+html_theme = "alabaster"
+
+html_static_path = ["_static"]
+
+html_logo = "_static/arroyo.png"

docs/source/index.rst

@@ -0,0 +1,7 @@
+.. include:: intro.rst
+
+Contents:
+---------
+
+.. toctree::
+   :maxdepth: 1

docs/source/intro.rst

@@ -0,0 +1,23 @@
+Arroyo is a library to build streaming applications that consume from
+and produce to Kafka.
+
+It relies on the `confluent_kafka` python library, which itself relies
+on `librdkafka`.
+
+Arroyo provides mainly three functionalities:
+
+* A set of abstractions inspired to common messaging applications patterns.
+* Some abstractions to simplify offset management and rebalancing.
+* An in memory broker abstraction to simplify writing unit tests.
+
+
+Getting Started
+***************
+
+Install it with pip.
+
+.. code-block:: python
+
+   pip install sentry-arroyo
+
+Find some `examples of usage <https://github.com/getsentry/arroyo/tree/main/examples>`_.