Add readthedocs

TuxEatPi · Aug 31, 2016 · 712b69c · 712b69c
1 parent c8cff20
commit 712b69c
Show file tree

Hide file tree

Showing 20 changed files with 191 additions and 8 deletions.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -20,6 +20,18 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
+import sys
+from unittest.mock import MagicMock
+
+class Mock(MagicMock):
+    @classmethod
+    def __getattr__(cls, name):
+            return Mock()
+
+MOCK_MODULES = ['pyaudio', 'speex']
+sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.

diff --git a/doc/source/refs/tuxeatpi.actionner.actionner.rst b/doc/source/refs/tuxeatpi.actionner.actionner.rst
@@ -0,0 +1,7 @@
+tuxeatpi.actionner.actionner module
+===================================
+
+.. automodule:: tuxeatpi.actionner.actionner
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/refs/tuxeatpi.actionner.rst b/doc/source/refs/tuxeatpi.actionner.rst
@@ -0,0 +1,15 @@
+tuxeatpi.actionner package
+==========================
+
+.. automodule:: tuxeatpi.actionner
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   tuxeatpi.actionner.actionner
+
diff --git a/doc/source/refs/tuxeatpi.actions.rst b/doc/source/refs/tuxeatpi.actions.rst
@@ -0,0 +1,15 @@
+tuxeatpi.actions package
+========================
+
+.. automodule:: tuxeatpi.actions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   tuxeatpi.actions.tux
+
diff --git a/doc/source/refs/tuxeatpi.actions.tux.rst b/doc/source/refs/tuxeatpi.actions.tux.rst
@@ -0,0 +1,7 @@
+tuxeatpi.actions.tux module
+===========================
+
+.. automodule:: tuxeatpi.actions.tux
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/refs/tuxeatpi.error.rst b/doc/source/refs/tuxeatpi.error.rst
diff --git a/doc/source/refs/tuxeatpi.hotword.hotword.rst b/doc/source/refs/tuxeatpi.hotword.hotword.rst
@@ -0,0 +1,7 @@
+tuxeatpi.hotword.hotword module
+===============================
+
+.. automodule:: tuxeatpi.hotword.hotword
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/refs/tuxeatpi.hotword.rst b/doc/source/refs/tuxeatpi.hotword.rst
@@ -0,0 +1,15 @@
+tuxeatpi.hotword package
+========================
+
+.. automodule:: tuxeatpi.hotword
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   tuxeatpi.hotword.hotword
+
diff --git a/doc/source/refs/tuxeatpi.libs.lang.rst b/doc/source/refs/tuxeatpi.libs.lang.rst
@@ -0,0 +1,7 @@
+tuxeatpi.libs.lang module
+=========================
+
+.. automodule:: tuxeatpi.libs.lang
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/refs/tuxeatpi.libs.rst b/doc/source/refs/tuxeatpi.libs.rst
@@ -0,0 +1,17 @@
+tuxeatpi.libs package
+=====================
+
+.. automodule:: tuxeatpi.libs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   tuxeatpi.libs.lang
+   tuxeatpi.libs.settings
+   tuxeatpi.libs.websocket
+
diff --git a/doc/source/refs/tuxeatpi.libs.settings.rst b/doc/source/refs/tuxeatpi.libs.settings.rst
@@ -0,0 +1,7 @@
+tuxeatpi.libs.settings module
+=============================
+
+.. automodule:: tuxeatpi.libs.settings
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/refs/tuxeatpi.libs.websocket.rst b/doc/source/refs/tuxeatpi.libs.websocket.rst
@@ -0,0 +1,7 @@
+tuxeatpi.libs.websocket module
+==============================
+
+.. automodule:: tuxeatpi.libs.websocket
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/refs/tuxeatpi.nlu.common.rst b/doc/source/refs/tuxeatpi.nlu.common.rst
@@ -0,0 +1,7 @@
+tuxeatpi.nlu.common module
+==========================
+
+.. automodule:: tuxeatpi.nlu.common
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/refs/tuxeatpi.nlu.nlu.rst b/doc/source/refs/tuxeatpi.nlu.nlu.rst
@@ -0,0 +1,7 @@
+tuxeatpi.nlu.nlu module
+=======================
+
+.. automodule:: tuxeatpi.nlu.nlu
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/refs/tuxeatpi.nlu.rst b/doc/source/refs/tuxeatpi.nlu.rst
@@ -0,0 +1,16 @@
+tuxeatpi.nlu package
+====================
+
+.. automodule:: tuxeatpi.nlu
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   tuxeatpi.nlu.common
+   tuxeatpi.nlu.nlu
+
diff --git a/doc/source/refs/tuxeatpi.rst b/doc/source/refs/tuxeatpi.rst
@@ -11,14 +11,19 @@ Subpackages
 
 .. toctree::
 
+    tuxeatpi.actionner
+    tuxeatpi.actions
     tuxeatpi.components
     tuxeatpi.fake_components
+    tuxeatpi.hotword
+    tuxeatpi.libs
+    tuxeatpi.nlu
+    tuxeatpi.voice
 
 Submodules
 ----------
 
 .. toctree::
 
-   tuxeatpi.error
    tuxeatpi.tux
 
diff --git a/doc/source/refs/tuxeatpi.voice.common.rst b/doc/source/refs/tuxeatpi.voice.common.rst
@@ -0,0 +1,7 @@
+tuxeatpi.voice.common module
+============================
+
+.. automodule:: tuxeatpi.voice.common
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/refs/tuxeatpi.voice.rst b/doc/source/refs/tuxeatpi.voice.rst
@@ -0,0 +1,16 @@
+tuxeatpi.voice package
+======================
+
+.. automodule:: tuxeatpi.voice
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   tuxeatpi.voice.common
+   tuxeatpi.voice.voice
+
diff --git a/doc/source/refs/tuxeatpi.voice.voice.rst b/doc/source/refs/tuxeatpi.voice.voice.rst
@@ -0,0 +1,7 @@
+tuxeatpi.voice.voice module
+===========================
+
+.. automodule:: tuxeatpi.voice.voice
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/requirements-doc.txt b/requirements-doc.txt
@@ -0,0 +1,9 @@
+# Main
+RPi.GPIO
+PyYAML
+# Audio
+aiohttp==0.16.2
+asyncio==3.4.3
+https://github.com/TuxEatPi/GPIOSim/archive/master.zip
+sphinx-rtd-theme
+Sphinx==1.4.5