Merge branch 'docs' of https://github.com/simpeg/simpeg into feat/docs-deploy

# Conflicts:
#	SimPEG/Utils/meshutils.py
#	docs/api_Utils.rst
#	docs/conf.py
#	docs/flow/index.rst
This commit is contained in:
Rowan Cockett
2016-05-29 19:18:36 -07:00
17 changed files with 123 additions and 66 deletions
+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:
+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:
+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:
+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:
+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:
+2
View File
@@ -46,6 +46,8 @@ The API
=======
.. autofunction:: SimPEG.Utils.SolverUtils.SolverWrapD
:noindex:
.. autofunction:: SimPEG.Utils.SolverUtils.SolverWrapI
:noindex:
+2 -2
View File
@@ -51,7 +51,6 @@ Interpolation Utilities
Counter Utilities
=================
.. code-block:: python
:linenos:
@@ -73,7 +72,6 @@ Counter Utilities
c.counter.summary()
.. code-block:: text
:linenos:
@@ -83,6 +81,8 @@ Counter Utilities
Times: mean sum
MyClass.MySecondMethod : 1.70e-06, 5.10e-04, 300x
The API
-------
+8 -2
View File
@@ -28,7 +28,7 @@ sys.path.append('../')
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc', 'matplotlib.sphinxext.plot_directive']
extensions = ['sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'matplotlib.sphinxext.plot_directive']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -129,7 +129,7 @@ except Exception, e:
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
@@ -229,6 +229,12 @@ man_pages = [
# If true, show URL addresses after external links.
#man_show_urls = False
# Intersphinx
intersphinx_mapping = {'python': ('http://docs.python.org/2', None),
'numpy': ('http://docs.scipy.org/doc/numpy/', None),
'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
'matplotlib': ('http://matplotlib.sourceforge.net/', None)}
# -- Options for Texinfo output ------------------------------------------------