Merge pull request #15 from llawall/rtd-setup

Add Read The Docs theme
wintoncode · Jul 14, 2017 · 6e2abbd · 6e2abbd
2 parents 0cff659 + 8ef5da9
commit 6e2abbd
Show file tree

Hide file tree

Showing 8 changed files with 153 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -84,7 +84,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "sphinx_rtd_theme"
 
 # 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

diff --git a/docs/index.rst b/docs/index.rst
@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 Welcome to Winton Kafka Streams Python's documentation!
-===============================================
+=======================================================
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -0,0 +1,7 @@
+winton_kafka_streams
+====================
+
+.. toctree::
+   :maxdepth: 4
+
+   winton_kafka_streams
diff --git a/docs/source/winton_kafka_streams.processor.rst b/docs/source/winton_kafka_streams.processor.rst
@@ -0,0 +1,61 @@
+winton\_kafka\_streams\.processor package
+=========================================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    winton_kafka_streams.processor.serde
+
+Submodules
+----------
+
+winton\_kafka\_streams\.processor\.extract\_timestamp module
+------------------------------------------------------------
+
+.. automodule:: winton_kafka_streams.processor.extract_timestamp
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+winton\_kafka\_streams\.processor\.processor module
+---------------------------------------------------
+
+.. automodule:: winton_kafka_streams.processor.processor
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+winton\_kafka\_streams\.processor\.processor\_context module
+------------------------------------------------------------
+
+.. automodule:: winton_kafka_streams.processor.processor_context
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+winton\_kafka\_streams\.processor\.topology module
+--------------------------------------------------
+
+.. automodule:: winton_kafka_streams.processor.topology
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+winton\_kafka\_streams\.processor\.wallclock\_timestamp module
+--------------------------------------------------------------
+
+.. automodule:: winton_kafka_streams.processor.wallclock_timestamp
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: winton_kafka_streams.processor
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/winton_kafka_streams.processor.serde.rst b/docs/source/winton_kafka_streams.processor.serde.rst
@@ -0,0 +1,22 @@
+winton\_kafka\_streams\.processor\.serde package
+================================================
+
+Submodules
+----------
+
+winton\_kafka\_streams\.processor\.serde\.identity module
+---------------------------------------------------------
+
+.. automodule:: winton_kafka_streams.processor.serde.identity
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: winton_kafka_streams.processor.serde
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/winton_kafka_streams.rst b/docs/source/winton_kafka_streams.rst
@@ -0,0 +1,38 @@
+winton\_kafka\_streams package
+==============================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    winton_kafka_streams.processor
+    winton_kafka_streams.state
+
+Submodules
+----------
+
+winton\_kafka\_streams\.kafka\_config module
+--------------------------------------------
+
+.. automodule:: winton_kafka_streams.kafka_config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+winton\_kafka\_streams\.kafka\_stream module
+--------------------------------------------
+
+.. automodule:: winton_kafka_streams.kafka_stream
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: winton_kafka_streams
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/winton_kafka_streams.state.rst b/docs/source/winton_kafka_streams.state.rst
@@ -0,0 +1,22 @@
+winton\_kafka\_streams\.state package
+=====================================
+
+Submodules
+----------
+
+winton\_kafka\_streams\.state\.simple module
+--------------------------------------------
+
+.. automodule:: winton_kafka_streams.state.simple
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: winton_kafka_streams.state
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/setup.py b/setup.py
@@ -47,7 +47,7 @@
     test_suite='tests',
     tests_require=test_requirements,
     extras_require={
-        'develop': ['pytest'],
+        'develop': ['pytest', 'sphinx_rtd_theme'],
         'binning_example': ['jupyter', 'pandas', 'bokeh'],
     }
 )