wassname/simpeg
1
0
Fork 0
mirror of https://github.com/wassname/simpeg.git synced 2026-07-19 11:28:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs clean-up (using autoclass is more stable than automodule)

Browse Source
This commit is contained in:
Lindsey Heagy
2016-01-31 15:21:46 -08:00
parent 2254eedbac
commit 6b359f49b5
9 changed files with 61 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api_ForwardProblem.rst
+2 -2
View File
@@ -67,13 +67,13 @@ The API
Problem
-------
.. automodule:: SimPEG.Problem
.. autoclass:: SimPEG.Problem
:members:
:undoc-members:
Survey
------
.. automodule:: SimPEG.Survey
.. autoclass:: SimPEG.Survey
:members:
:undoc-members:
docs/api_InnerProducts.rst
+1 -1
View File
@@ -266,6 +266,6 @@ These are computed for each of the 8 projections, horizontally concatenated, and
The API
-------
.. automodule:: SimPEG.Mesh.InnerProducts
.. autoclass:: SimPEG.Mesh.InnerProducts
:members:
:undoc-members:
docs/api_Inversion.rst
+3 -3
View File
@@ -3,7 +3,7 @@
InvProblem
**********
.. automodule:: SimPEG.InvProblem
.. autoclass:: SimPEG.InvProblem
:show-inheritance:
:members:
:undoc-members:
@@ -12,7 +12,7 @@ InvProblem
Inversion
*********
.. automodule:: SimPEG.Inversion
.. autoclass:: SimPEG.Inversion
:show-inheritance:
:members:
:undoc-members:
@@ -20,7 +20,7 @@ Inversion
Directives
**********
.. automodule:: SimPEG.Directives
.. autoclass:: SimPEG.Directives
:show-inheritance:
:members:
:undoc-members:
docs/api_Mesh.rst
+1 -1
View File
@@ -188,6 +188,6 @@ other types of meshes in this SimPEG framework.
The API
=======
.. automodule:: SimPEG.Mesh.BaseMesh
.. autoclass:: SimPEG.Mesh.BaseMesh
:members:
:undoc-members:
docs/api_MeshCode.rst
+7 -10
View File
@@ -3,34 +3,31 @@
Tensor Mesh
===========
.. automodule:: SimPEG.Mesh.TensorMesh
:show-inheritance:
.. autoclass:: SimPEG.Mesh.TensorMesh
:members:
:undoc-members:
:show-inheritance:
Cylindrical Mesh
================
.. automodule:: SimPEG.Mesh.CylMesh
:show-inheritance:
.. autoclass:: SimPEG.Mesh.CylMesh
:members:
:undoc-members:
:show-inheritance:
Tree Mesh
=========
.. autoclass:: SimPEG.Mesh.TreeMesh.TreeMesh
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Curvilinear Mesh
================
.. automodule:: SimPEG.Mesh.CurvilinearMesh
:show-inheritance:
.. autoclass:: SimPEG.Mesh.CurvilinearMesh
:members:
:undoc-members:
:show-inheritance: