Add readthedocs

TuxEatPi · Aug 31, 2016 · 311de5e · 311de5e
1 parent c8cff20
commit 311de5e
Show file tree

Hide file tree

Showing 25 changed files with 210 additions and 37 deletions.
diff --git a/Makefile b/Makefile
@@ -19,6 +19,7 @@ env-dev:
 env:
 	virtualenv -p /usr/bin/python3 env
 	env/bin/pip3 install RPi.GPIO
+	env/bin/pip3 install -r requirements.txt
 
 tux_example:
 	env/bin/python examples/simple_tux_with_gpiosim.py

diff --git a/circle.yml b/circle.yml
@@ -35,26 +35,3 @@ test:
     - mkdir -p $CIRCLE_TEST_REPORTS/html/
     - cp nosetests.html $CIRCLE_TEST_REPORTS/html/
     - cp -r htmlcov $CIRCLE_TEST_REPORTS/coverage
-
-deployment:
-  gh_pages:
-    branch: master
-    commands:
-      - python setup.py develop
-      - python -c "import tuxeatpi"
-      - make doc-generate
-      - rm -rf ../documentation
-      - mkdir ../documentation
-      - cd ../documentation && git init
-      - cd ../documentation && git remote add origin https://${GH_TOKEN}:x-oauth-basic@github.com/TuxEatPi/tuxeatpi.git
-      - cd ../documentation && git pull origin gh-pages
-      - cd ../documentation && git checkout gh-pages
-      - cd ../documentation && git clean -fxd
-      - cd ../documentation && git config user.name 'Tuxeatpi Team'
-      - cd ../documentation && git config user.email 'tuxeatpi@tuxeatpi.org'
-      - cd ../documentation && rm -rf *
-      - cp -r doc/build/html/* ../documentation/
-      - cp doc/build/html/.nojekyll ../documentation/
-      - cd ../documentation && git add .
-      - cd ../documentation && git commit -m "Update documentation on $(date '+%Y/%m/%d%H:%M:%S')"
-      - cd ../documentation && git push origin gh-pages --force
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -20,6 +20,26 @@
 # 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 = []
+try:
+    import pyaudio
+except ImportError:
+    MOCK_MODULES.append('pyaudio')
+try:
+    import speex
+except ImportError:
+    MOCK_MODULES.append('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/index.rst b/doc/source/index.rst
@@ -11,6 +11,7 @@ Contents:
 .. toctree::
     :maxdepth: 2
 
+    refs/modules
 
 Indices and tables
 ==================

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
diff --git a/setup.py b/setup.py
@@ -21,6 +21,7 @@
             'tuxeatpi.nlu',
             'tuxeatpi.actionner',
             'tuxeatpi.actions',
+            'tuxeatpi.hotword',
             'tuxeatpi.components',
             'tuxeatpi.fake_components',
             ]

diff --git a/tuxeatpi/libs/lang.py b/tuxeatpi/libs/lang.py
@@ -19,13 +19,15 @@ def load_languages():
                                    localedir='tuxeatpi/locale',
                                    languages=['en'],
                                    fallback=True)
-    _lang_fr = gettext.translation('tuxeatpi',
-                                   localedir='tuxeatpi/locale',
-                                   languages=['fr'])
-    # Put languages in dict
     LANGUAGES['eng-USA'] = _lang_en
-    LANGUAGES['fra-FRA'] = _lang_fr
-    LANGUAGES['fra-CAN'] = _lang_fr
+    try:
+        _lang_fr = gettext.translation('tuxeatpi',
+                                       localedir='tuxeatpi/locale',
+                                       languages=['fr'])
+        LANGUAGES['fra-FRA'] = _lang_fr
+        LANGUAGES['fra-CAN'] = _lang_fr
+    except OSError:
+        pass
 
 
 def set_language(lang):