DOC: api added

doc/apidoc/tomopy.io.data.rst

@@ -0,0 +1,7 @@
+:mod:`data`
+===========
+
+.. automodule:: tomopy.io.data
+   :members:
+   :show-inheritance:
+   :undoc-members: 

doc/apidoc/tomopy.io.phantom.rst

@@ -0,0 +1,7 @@
+:mod:`phantom`
+==============
+
+.. automodule:: tomopy.io.phantom
+   :members:
+   :show-inheritance:
+   :undoc-members: 

doc/apidoc/tomopy.io.recipe.rst

@@ -0,0 +1,7 @@
+:mod:`recipe`
+=============
+
+.. automodule:: tomopy.io.recipe
+   :members:
+   :show-inheritance:
+   :undoc-members: 

doc/apidoc/tomopy.io.rst

@@ -0,0 +1,12 @@
+:mod:`io`
+=========
+
+.. toctree::
+   tomopy.io.data
+   tomopy.io.phantom
+   tomopy.io.recipe
+
+.. automodule:: tomopy.io
+   :members:
+   :show-inheritance:
+   :undoc-members: 

doc/apidoc/tomopy.misc.morph.rst

@@ -0,0 +1,7 @@
+:mod:`morph`
+============
+
+.. automodule:: tomopy.misc.morph
+   :members:
+   :show-inheritance:
+   :undoc-members: 

doc/apidoc/tomopy.misc.multiprocess.rst

@@ -0,0 +1,7 @@
+:mod:`multiprocess`
+===================
+
+.. automodule:: tomopy.misc.multiprocess
+   :members:
+   :show-inheritance:
+   :undoc-members: 

doc/apidoc/tomopy.misc.rst

@@ -0,0 +1,11 @@
+:mod:`misc`
+===========
+
+.. toctree::
+   tomopy.misc.morph
+   tomopy.misc.multiprocess
+
+.. automodule:: tomopy.misc
+   :members:
+   :show-inheritance:
+   :undoc-members: 

doc/apidoc/tomopy.prep.rst

@@ -0,0 +1,7 @@
+:mod:`prep`
+===========
+
+.. automodule:: tomopy.prep
+   :members:
+   :show-inheritance:
+   :undoc-members: 

doc/apidoc/tomopy.recon.rst

@@ -0,0 +1,7 @@
+:mod:`recon`
+============
+
+.. automodule:: tomopy.recon
+   :members:
+   :show-inheritance:
+   :undoc-members: 

doc/apidoc/tomopy.rst

@@ -0,0 +1,15 @@
+API reference
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   tomopy.io
+   tomopy.misc
+   tomopy.prep
+   tomopy.recon
+
+.. automodule:: tomopy
+   :members:
+   :undoc-members: 
+   :show-inheritance: 

doc/conf.py

@@ -16,23 +16,10 @@
 import sys
 import os
 
-from mock import Mock as MagicMock
-
-class Mock(MagicMock):
-    @classmethod
-    def __getattr__(cls, name):
-        return Mock()
-
-MOCK_MODULES = [
-    'numpy', 'scipy', 'scipy.misc', 'h5py', 'matplotlib', 
-    'matplotlib.pylab', 'scikit-image', 'skimage.io', 'numpydoc']
-sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath(os.path.join('..')))
-sys.path.insert(0, os.path.abspath(os.path.join('..', 'io')))
+sys.path.insert(0, os.path.abspath('..'))
 
 # -- General configuration ------------------------------------------------
 
@@ -305,5 +292,35 @@ def __getattr__(cls, name):
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #ztexinfo_no_detailmenu = False
 
+# picked from http://read-the-docs.readthedocs.org/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules  # noqa
+class Mock(object):
+
+    __all__ = []
+
+    def __init__(self, *args, **kwargs):
+        pass
+
+    def __call__(self, *args, **kwargs):
+        return Mock()
+
+    @classmethod
+    def __getattr__(cls, name):
+        if name in ('__file__', '__path__'):
+            return '/dev/null'
+        elif name == 'c_byte':
+            return 0
+        else:
+            return Mock()
+
+MOCK_MODULES = [
+    'numpy', 'scipy', 'scipy.misc', 'h5py', 'matplotlib', 'ctypes',
+    'matplotlib.pylab', 'scikit-image', 'skimage.io', 'numpydoc', 
+    'scipy.ndimage', 'pywt', 'scipy.optimize', 'skimage',
+    'skimage.filter', 'skimage.morphology']
+
+for mod_name in MOCK_MODULES:
+    sys.modules[mod_name] = Mock()
+
+
 # To turn-off the warnings at object generation.
 numpydoc_show_class_members = False

doc/index.rst

@@ -19,7 +19,7 @@ Feel free to edit as you see fit!
    quickstart
    userguide
    developer
-   api
+   apidoc/tomopy
    questions
    credits
 

tomopy/__init__.py

@@ -49,7 +49,7 @@
 from __future__ import absolute_import, division, print_function
 
 from tomopy.io import *
-from tomopy.io.recipes import *
+from tomopy.io.recipe import *
 from tomopy.io.data import *
 from tomopy.io.phantom import *
 from tomopy.misc.morph import *