update for RTFD

GeoStat-Framework · Aug 5, 2019 · 5cb2bc9 · 5cb2bc9
1 parent 89e7964
commit 5cb2bc9
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 22 deletions.
diff --git a/anaflow/__init__.py b/anaflow/__init__.py
@@ -26,7 +26,7 @@
 .. autosummary::
    thiem
    theis
-   grf_model
+   grf
 
 Heterogeneous
 ^^^^^^^^^^^^^
@@ -52,8 +52,8 @@
 The extended general radial flow model.
 
 .. autosummary::
-   grf_disk
-   grf_steady
+   ext_grf
+   ext_grf_steady
 
 Laplace
 =======

diff --git a/anaflow/flow/__init__.py b/anaflow/flow/__init__.py
@@ -26,7 +26,7 @@
 .. autosummary::
    thiem
    theis
-   grf_model
+   grf
 
 Heterogeneous
 ~~~~~~~~~~~~~

diff --git a/anaflow/flow/ext_grf.py b/anaflow/flow/ext_grf.py
@@ -7,8 +7,8 @@
 The following functions are provided
 
 .. autosummary::
-   grf_disk
-   grf_steady
+   ext_grf
+   ext_grf_steady
 """
 # pylint: disable=C0103
 from __future__ import absolute_import, division, print_function

diff --git a/docs/source/flow.special.rst → docs/source/flow.ext_grf.rst b/docs/source/flow.special.rst → docs/source/flow.ext_grf.rst
@@ -1,7 +1,7 @@
-anaflow.flow.special
+anaflow.flow.ext_grf
 ====================
 
-.. automodule:: anaflow.flow.special
+.. automodule:: anaflow.flow.ext_grf
    :members:
    :undoc-members:
    :show-inheritance:

diff --git a/docs/source/flow.rst b/docs/source/flow.rst
@@ -12,5 +12,5 @@ anaflow.flow
 
    flow.homogeneous.rst
    flow.heterogeneous.rst
-   flow.special.rst
+   flow.ext_grf.rst
    flow.laplace.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -27,17 +27,17 @@ Provided Functions
 
 The following functions are provided directly
 
-* ``thiem`` Thiem solution for steady state pumping
-* ``theis`` Theis solution for transient pumping
-* ``ext_thiem_2d`` extended Thiem solution in 2D from *Zech 2013*
-* ``ext_theis_2d`` extended Theis solution in 2D from *Mueller 2015*
-* ``ext_thiem_3d`` extended Thiem solution in 3D from *Zech 2013*
-* ``ext_theis_3d`` extended Theis solution in 3D from *Mueller 2015*
-* ``neuman2004`` transient solution from *Neuman 2004*
-* ``neuman2004_steady`` steady solution from *Neuman 2004*
-* ``grf`` "General Radial Flow" Model
-* ``ext_grf`` the transient extended GRF model
-* ``ext_grf_steady`` the steady extended GRF model
+* :any:`thiem` Thiem solution for steady state pumping
+* :any:`theis` Theis solution for transient pumping
+* :any:`ext_thiem_2d` extended Thiem solution in 2D from *Zech 2013*
+* :any:`ext_theis_2d` extended Theis solution in 2D from *Mueller 2015*
+* :any:`ext_thiem_3d` extended Thiem solution in 3D from *Zech 2013*
+* :any:`ext_theis_3d` extended Theis solution in 3D from *Mueller 2015*
+* :any:`neuman2004` transient solution from *Neuman 2004*
+* :any:`neuman2004_steady` steady solution from *Neuman 2004*
+* :any:`grf` "General Radial Flow" Model
+* :py:func:`ext_grf` the transient extended GRF model
+* :any:`ext_grf_steady` the steady extended GRF model
 
 
 Laplace Transformation
@@ -46,8 +46,8 @@ Laplace Transformation
 We provide routines to calculate the laplace-transformation as well as the
 inverse laplace-transformation of a given function
 
-* ``get_lap`` Get the laplace transformation of a function
-* ``get_lap_inv`` Get the inverse laplace transformation of a function
+* :any:`get_lap` Get the laplace transformation of a function
+* :any:`get_lap_inv` Get the inverse laplace transformation of a function
 
 
 Requirements