Documentation Updates

SimPEG/Problem.py

@@ -51,7 +51,8 @@ class BaseProblem(object):
 
     @Utils.timeIt
     def Jvec(self, m, v, u=None):
-        """
+        """Jvec(m, v, u=None)
+
             Effect of J(m) on a vector v.
 
             :param numpy.array m: model
@@ -64,7 +65,8 @@ class BaseProblem(object):
 
     @Utils.timeIt
     def Jtvec(self, m, v, u=None):
-        """
+        """Jtvec(m, v, u=None)
+
             Effect of transpose of J(m) on a vector v.
 
             :param numpy.array m: model
@@ -78,7 +80,8 @@ class BaseProblem(object):
 
     @Utils.timeIt
     def Jvec_approx(self, m, v, u=None):
-        """
+        """Jvec_approx(m, v, u=None)
+
             Approximate effect of J(m) on a vector v
 
             :param numpy.array m: model
@@ -91,7 +94,8 @@ class BaseProblem(object):
 
     @Utils.timeIt
     def Jtvec_approx(self, m, v, u=None):
-        """
+        """Jtvec_approx(m, v, u=None)
+
             Approximate effect of transpose of J(m) on a vector v.
 
             :param numpy.array m: model

docs/api_Mesh.rst

@@ -197,7 +197,6 @@ other types of meshes in this SimPEG framework.
 The API
 =======
 
-.. toctree::
-   :maxdepth: 2
-
-   api_MeshCode
+.. automodule:: SimPEG.Mesh.BaseMesh
+    :members:
+    :undoc-members:

docs/api_MeshCode.rst

@@ -25,11 +25,3 @@ Cylindrical 1D Mesh
     :show-inheritance:
     :members:
     :undoc-members:
-
-
-Base Mesh
-=========
-
-.. automodule:: SimPEG.Mesh.BaseMesh
-    :members:
-    :undoc-members:

docs/index.rst

@@ -27,7 +27,7 @@ Meshing & Operators
 *******************
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
    api_Mesh
    api_DiffOps
@@ -39,9 +39,9 @@ Forward Problems
 .. toctree::
    :maxdepth: 2
 
-   api_Maps
-   api_Survey
    api_Problem
+   api_Survey
+   api_Maps
 
 Inversion
 *********