DOC: Documentation updates

hoechenberger · Sep 4, 2015 · a3bf669 · a3bf669
1 parent 91c9f96
commit a3bf669
Show file tree

Hide file tree

Showing 16 changed files with 48 additions and 54 deletions.
diff --git a/doc/build-docs.bat b/doc/build-docs.bat
@@ -1,6 +1,6 @@
 @echo off
 rmdir /s /q build
-% del source\pphelper.rst
-% del source\modules.rst
-% sphinx-apidoc -f -o source ..\pphelper ..\pphelper\version.py ..\pphelper\tests
+REM del source\pphelper.rst
+REM del source\modules.rst
+REM sphinx-apidoc --no-toc -f -o source ..\pphelper ..\pphelper\version.py ..\pphelper\tests
 make html
diff --git a/doc/build-docs.sh b/doc/build-docs.sh
@@ -1,5 +1,5 @@
 #!/usr/bin/env sh
 
-rm -rf build source/pphelper.rst source/modules.rst
-# sphinx-apidoc -o source ../pphelper ../pphelper/version.py ../pphelper/tests
+# rm -rf build source/pphelper.rst source/modules.rst
+# sphinx-apidoc --no-toc -f -o source ../pphelper ../pphelper/version.py ../pphelper/tests
 make html
diff --git a/doc/source/about.rst b/doc/source/about.rst
@@ -2,6 +2,7 @@ About pphelper
 ==============
 
 .. automodule:: pphelper
-    :members:
-    :undoc-members:
-    :inherited-members:
+    :no-members:
+    :no-undoc-members:
+    :no-inherited-members:
+    :no-show-inheritance:
diff --git a/doc/source/analoginput.rst b/doc/source/analoginput.rst
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -63,13 +63,24 @@ def __getattr__(cls, name):
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
     # 'sphinx.ext.doctest',
     # 'sphinx.ext.todo',
     'sphinx.ext.viewcode',
     # 'numpydoc',
     'sphinxcontrib.napoleon',
 ]
 
+autodoc_default_flags = [
+    'members',
+    'undoc-members',
+    'inherited-members',
+    'show-inheritance'
+]
+
+# Also document __init__() methods.
+autoclass_content = 'both'
+
 # Napoleon settings
 napoleon_include_special_with_doc = False
 
@@ -94,7 +105,7 @@ def __getattr__(cls, name):
 # built documents.
 #
 
-import pphelper
+# import pphelper
 # Ger version info.
 # This basically imports __version__ from version.py.
 exec(open('../../pphelper/version.py').read())

diff --git a/doc/source/gustometer.rst b/doc/source/gustometer.rst
diff --git a/doc/source/hardware.rst b/doc/source/hardware.rst
@@ -2,8 +2,16 @@ The ``hardware`` Module
 =======================
 
 .. toctree::
-   :maxdepth: 1
+    :maxdepth: 1
 
-   olfactometer
-   analoginput
-   gustometer
+Olfactometer
+------------
+.. autoclass:: pphelper.hardware.Olfactometer
+
+Gustometer
+----------
+.. autoclass:: pphelper.hardware.Gustometer
+
+AnalogInput
+-----------
+.. autoclass:: pphelper.hardware.AnalogInput
diff --git a/doc/source/image.rst b/doc/source/image.rst
@@ -2,6 +2,4 @@ The ``image`` Module
 ====================
 
 .. automodule:: pphelper.image
-    :members:
-    :undoc-members:
-    :inherited-members:
+    :noindex:
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -6,12 +6,13 @@
 Welcome to pphelper's documentation!
 ====================================
 .. Contents:
+
 .. toctree::
    :maxdepth: 1
 
    about
+   hardware
    racemodel
    sdt
-   hardware
    image
    utils
diff --git a/doc/source/olfactometer.rst b/doc/source/olfactometer.rst
diff --git a/doc/source/racemodel.rst b/doc/source/racemodel.rst
@@ -5,3 +5,4 @@ The ``racemodel`` Module
     :members:
     :undoc-members:
     :inherited-members:
+    :noindex:
diff --git a/doc/source/sdt.rst b/doc/source/sdt.rst
@@ -1,7 +1,5 @@
-The ``utils`` Module
+The ``sdt`` Module
 ====================
 
 .. automodule:: pphelper.sdt
-    :members:
-    :undoc-members:
-    :inherited-members:
+    :noindex:
diff --git a/doc/source/utils.rst b/doc/source/utils.rst
@@ -2,6 +2,4 @@ The ``utils`` Module
 ====================
 
 .. automodule:: pphelper.utils
-    :members:
-    :undoc-members:
-    :inherited-members:
+    :noindex:
diff --git a/pphelper/__init__.py b/pphelper/__init__.py
@@ -15,4 +15,4 @@
     print('Problem importing the hardware module, skipping.\n'
           'Please check if PyLibNIDAQmx is installed.')
 
-__all__ = ['racemodel', 'sdt', 'hardware', 'utils', 'image']
+__all__ = ['racemodel', 'hardware', 'image', 'sdt', 'utils']
diff --git a/pphelper/image.py b/pphelper/image.py
@@ -1,8 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-pphelper.image
-==================
+Some basic image processing routines.
 
 Provides
 --------

diff --git a/pphelper/sdt.py b/pphelper/sdt.py
@@ -1,13 +1,14 @@
 # -*- coding: utf-8 -*-
 
 """
-Some functions that come in handy when working with psychophysics
-datasets.
+Signal detection theory calculations.
 
 Provides
 --------
- - ``d_prime`` : Calculate the sensitivity index d' ("d-prime").
- - ``criterion`` : Calculate the decision criterion C.
+ - ``d_prime`` : Calculate the sensitivity index *d'*.
+ - ``a_prime`` : Calculate the sensitivity index *A'*.
+ - ``criterion`` : Calculate the decision criterion *C*.
+
 """
 
 from __future__ import division, unicode_literals
@@ -17,7 +18,7 @@
 
 def d_prime(hits, false_alarms, n, nafc=1):
     """
-    Calculate the sensitivity index d' ("d-prime").
+    Calculate the sensitivity index d'.
 
     Parameters
     ----------