From 176ca053518d76e3a8d876adec8f0d13a83949d1 Mon Sep 17 00:00:00 2001 From: rowanc1 Date: Sat, 17 May 2014 23:41:05 -0700 Subject: [PATCH] forward problem combined in docs --- ...api_Problem.rst => api_ForwardProblem.rst} | 19 ++++++++++++++++--- docs/api_Survey.rst | 11 ----------- docs/index.rst | 3 +-- 3 files changed, 17 insertions(+), 16 deletions(-) rename docs/{api_Problem.rst => api_ForwardProblem.rst} (91%) delete mode 100644 docs/api_Survey.rst diff --git a/docs/api_Problem.rst b/docs/api_ForwardProblem.rst similarity index 91% rename from docs/api_Problem.rst rename to docs/api_ForwardProblem.rst index 0c371b55..b8f2fd90 100644 --- a/docs/api_Problem.rst +++ b/docs/api_ForwardProblem.rst @@ -1,8 +1,11 @@ -.. _api_Problem: +.. _api_ForwardProblem: -Problem -******* +Forward Problem +*************** + +Problem Class +============= The problem is a partial differential equation of the form: @@ -62,10 +65,20 @@ This can often be computed given a vector (i.e. \\(J(v)\\)) rather than stored, u(m) + + The API ======= +Problem +------- .. automodule:: SimPEG.Problem :members: :undoc-members: +Survey +------ + +.. automodule:: SimPEG.Survey + :members: + diff --git a/docs/api_Survey.rst b/docs/api_Survey.rst deleted file mode 100644 index 25fd0e37..00000000 --- a/docs/api_Survey.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _api_Survey: - - -Survey -====== - -.. automodule:: SimPEG.Survey - :show-inheritance: - :members: - :undoc-members: - :inherited-members: diff --git a/docs/index.rst b/docs/index.rst index 88cc4ee1..7fc4bae9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -56,8 +56,7 @@ Forward Problems .. toctree:: :maxdepth: 2 - api_Problem - api_Survey + api_ForwardProblem Inversion *********