From 5f64ea8399e114f1909e906d8d53a698941ebb7e Mon Sep 17 00:00:00 2001 From: Rowan Cockett Date: Thu, 21 Nov 2013 12:25:56 -0800 Subject: [PATCH] Documentation Updates. --- docs/api_LogicallyOrthogonalMesh.rst | 2 ++ docs/api_Optimize.rst | 4 ++++ docs/api_Problem.rst | 9 ++++++--- docs/api_TensorMesh.rst | 2 ++ 4 files changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/api_LogicallyOrthogonalMesh.rst b/docs/api_LogicallyOrthogonalMesh.rst index 9d7d516b..c59d7886 100644 --- a/docs/api_LogicallyOrthogonalMesh.rst +++ b/docs/api_LogicallyOrthogonalMesh.rst @@ -4,8 +4,10 @@ Logically Orthogonal Mesh ************************* .. automodule:: SimPEG.mesh.LogicallyOrthogonalMesh + :show-inheritance: :members: :undoc-members: + :inherited-members: LOM View diff --git a/docs/api_Optimize.rst b/docs/api_Optimize.rst index d726b5f8..283d8ce9 100644 --- a/docs/api_Optimize.rst +++ b/docs/api_Optimize.rst @@ -4,16 +4,20 @@ Optimize ******** .. automodule:: SimPEG.inverse.Optimize + :show-inheritance: :members: :undoc-members: + :inherited-members: Inversion ********* .. automodule:: SimPEG.inverse.Inversion + :show-inheritance: :members: :undoc-members: + :inherited-members: Beta Schedule ************* diff --git a/docs/api_Problem.rst b/docs/api_Problem.rst index 3d5a6d2c..b4c96c4a 100644 --- a/docs/api_Problem.rst +++ b/docs/api_Problem.rst @@ -1,21 +1,24 @@ .. _api_Problem: - Problem ******* .. automodule:: SimPEG.forward.Problem + :show-inheritance: :members: :undoc-members: + :inherited-members: DCProblem ********* .. automodule:: SimPEG.forward.DCProblem + :show-inheritance: :members: :undoc-members: + :inherited-members: @@ -23,7 +26,7 @@ Linear Problem ************** .. automodule:: SimPEG.forward.LinearProblem + :show-inheritance: :members: :undoc-members: - - + :inherited-members: diff --git a/docs/api_TensorMesh.rst b/docs/api_TensorMesh.rst index 9de206f1..5dc3b280 100644 --- a/docs/api_TensorMesh.rst +++ b/docs/api_TensorMesh.rst @@ -4,8 +4,10 @@ Tensor Mesh *********** .. automodule:: SimPEG.mesh.TensorMesh + :show-inheritance: :members: :undoc-members: + :inherited-members: Tensor View ***********