Autodoc modules

.gitignore

@@ -38,6 +38,7 @@ MANIFEST
 # Sphinx
 docs/api
 docs/_build
+docs/_static
 
 # Eclipse editor project files
 .project

docs/conf.py

@@ -14,15 +14,25 @@
 import os
 import sys
 from recommonmark.parser import CommonMarkParser
+from mock import Mock as MagicMock
 
 # The docs are built on the ReadTheDocs website in a virtualenv
 # the we don't necessarily control. The below line is used to
 # add POCS to the path without installing or our usual env vars.
-sys.path.insert(0, os.path.abspath('../pocs'))
+sys.path.insert(0, os.path.abspath('../'))
 
 from pocs.version import __version__
 
 
+class Mock(MagicMock):
+    @classmethod
+    def __getattr__(cls, name):
+        return MagicMock()
+
+
+MOCK_MODULES = ['numpy', 'scipy', 'scipy.linalg', 'scipy.signal']
+sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+
 # -- Project information -----------------------------------------------------
 
 project = 'POCS'

docs/modules.rst

@@ -1,4 +1,4 @@
-pocs
+POCS
 ====
 
 .. toctree::
@@ -7,4 +7,10 @@ pocs
    peas
    pocs
    pocs.camera
+   pocs.dome
+   pocs.focuser
    pocs.mount
+   pocs.scheduler
+   pocs.sensors
+   pocs.state
+   pocs.utils

docs/requirements.txt

@@ -1,2 +1,3 @@
 sphinx_rtd_theme
-recommonmark
+recommonmark
+mock

docs/source/peas.rst

@@ -0,0 +1,38 @@
+peas package
+============
+
+Submodules
+----------
+
+peas.PID module
+---------------
+
+.. automodule:: peas.PID
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+peas.sensors module
+-------------------
+
+.. automodule:: peas.sensors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+peas.weather module
+-------------------
+
+.. automodule:: peas.weather
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: peas
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/pocs.tests.bisque.rst

@@ -0,0 +1,38 @@
+pocs.tests.bisque package
+=========================
+
+Submodules
+----------
+
+pocs.tests.bisque.test\_dome module
+-----------------------------------
+
+.. automodule:: pocs.tests.bisque.test_dome
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.bisque.test\_mount module
+------------------------------------
+
+.. automodule:: pocs.tests.bisque.test_mount
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.bisque.test\_run module
+----------------------------------
+
+.. automodule:: pocs.tests.bisque.test_run
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: pocs.tests.bisque
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/pocs.tests.data.rst

@@ -0,0 +1,10 @@
+pocs.tests.data package
+=======================
+
+Module contents
+---------------
+
+.. automodule:: pocs.tests.data
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/pocs.tests.rst

@@ -0,0 +1,232 @@
+pocs.tests package
+==================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    pocs.tests.bisque
+    pocs.tests.data
+    pocs.tests.serial_handlers
+    pocs.tests.utils
+
+Submodules
+----------
+
+pocs.tests.conftest module
+--------------------------
+
+.. automodule:: pocs.tests.conftest
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_arduino\_io module
+-----------------------------------
+
+.. automodule:: pocs.tests.test_arduino_io
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_astrohaven\_dome module
+----------------------------------------
+
+.. automodule:: pocs.tests.test_astrohaven_dome
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_base module
+----------------------------
+
+.. automodule:: pocs.tests.test_base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_base\_scheduler module
+---------------------------------------
+
+.. automodule:: pocs.tests.test_base_scheduler
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_camera module
+------------------------------
+
+.. automodule:: pocs.tests.test_camera
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_codestyle module
+---------------------------------
+
+.. automodule:: pocs.tests.test_codestyle
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_config module
+------------------------------
+
+.. automodule:: pocs.tests.test_config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_constraints module
+-----------------------------------
+
+.. automodule:: pocs.tests.test_constraints
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_database module
+--------------------------------
+
+.. automodule:: pocs.tests.test_database
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_dispatch\_scheduler module
+-------------------------------------------
+
+.. automodule:: pocs.tests.test_dispatch_scheduler
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_dome\_simulator module
+---------------------------------------
+
+.. automodule:: pocs.tests.test_dome_simulator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_field module
+-----------------------------
+
+.. automodule:: pocs.tests.test_field
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_focuser module
+-------------------------------
+
+.. automodule:: pocs.tests.test_focuser
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_horizon\_points module
+---------------------------------------
+
+.. automodule:: pocs.tests.test_horizon_points
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_images module
+------------------------------
+
+.. automodule:: pocs.tests.test_images
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_ioptron module
+-------------------------------
+
+.. automodule:: pocs.tests.test_ioptron
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_messaging module
+---------------------------------
+
+.. automodule:: pocs.tests.test_messaging
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_mount\_simulator module
+----------------------------------------
+
+.. automodule:: pocs.tests.test_mount_simulator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_observation module
+-----------------------------------
+
+.. automodule:: pocs.tests.test_observation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_observatory module
+-----------------------------------
+
+.. automodule:: pocs.tests.test_observatory
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_pocs module
+----------------------------
+
+.. automodule:: pocs.tests.test_pocs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_rs232 module
+-----------------------------
+
+.. automodule:: pocs.tests.test_rs232
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_social\_messaging module
+-----------------------------------------
+
+.. automodule:: pocs.tests.test_social_messaging
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_state\_machine module
+--------------------------------------
+
+.. automodule:: pocs.tests.test_state_machine
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pocs.tests.test\_theskyx\_utils module
+--------------------------------------
+
+.. automodule:: pocs.tests.test_theskyx_utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: pocs.tests
+    :members:
+    :undoc-members:
+    :show-inheritance: