diff --git a/docs/Makefile b/docs/Makefile index 587802672..11e5a7bbe 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,4 +1,4 @@ - # Makefile for Sphinx documentation +# Makefile for Sphinx documentation # # You can set these variables from the command line. diff --git a/docs/source/game_theory.rst b/docs/source/game_theory.rst index 65c7bf959..500a13180 100644 --- a/docs/source/game_theory.rst +++ b/docs/source/game_theory.rst @@ -9,6 +9,7 @@ Game theory game_theory/normal_form_game game_theory/pure_nash game_theory/random + game_theory/repeated_game game_theory/support_enumeration game_theory/utilities game_theory/vertex_enumeration diff --git a/docs/source/game_theory/repeated_game.rst b/docs/source/game_theory/repeated_game.rst new file mode 100644 index 000000000..3d9a1bb39 --- /dev/null +++ b/docs/source/game_theory/repeated_game.rst @@ -0,0 +1,7 @@ +repeated_game +============= + +.. automodule:: quantecon.game_theory.repeated_game + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/optimize.rst b/docs/source/optimize.rst index 4d25d1a12..564fc8ab6 100644 --- a/docs/source/optimize.rst +++ b/docs/source/optimize.rst @@ -4,5 +4,6 @@ Optimize .. toctree:: :maxdepth: 2 + optimize/nelder_mead optimize/root_finding optimize/scalar_maximization diff --git a/docs/source/optimize/nelder_mead.rst b/docs/source/optimize/nelder_mead.rst new file mode 100644 index 000000000..452370c4a --- /dev/null +++ b/docs/source/optimize/nelder_mead.rst @@ -0,0 +1,7 @@ +nelder_mead +=========== + +.. automodule:: quantecon.optimize.nelder_mead + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/tools.rst b/docs/source/tools.rst index ad6f60592..f5abd42f4 100644 --- a/docs/source/tools.rst +++ b/docs/source/tools.rst @@ -15,6 +15,7 @@ Tools tools/filter tools/graph_tools tools/gridtools + tools/inequality tools/ivp tools/kalman tools/lae diff --git a/docs/source/inequality.rst b/docs/source/tools/inequality.rst similarity index 58% rename from docs/source/inequality.rst rename to docs/source/tools/inequality.rst index 2cf290756..0b9b86669 100644 --- a/docs/source/inequality.rst +++ b/docs/source/tools/inequality.rst @@ -1,7 +1,7 @@ -Inquality +inequality ========== -.. automodule:: quantecon.inquality +.. automodule:: quantecon.inequality :members: :undoc-members: :show-inheritance: diff --git a/quantecon/inequality.py b/quantecon/inequality.py index 6c0abc89b..755916c86 100644 --- a/quantecon/inequality.py +++ b/quantecon/inequality.py @@ -30,7 +30,7 @@ def lorenz_curve(y): References ---------- - https://en.wikipedia.org/wiki/Lorenz_curve + .. [1] https://en.wikipedia.org/wiki/Lorenz_curve Examples -------- @@ -85,7 +85,7 @@ def gini_coefficient(y): def shorrocks_index(A): - """ + r""" Implements Shorrocks mobility index Parameters @@ -100,16 +100,16 @@ def shorrocks_index(A): The Shorrocks mobility index calculated as .. math:: - - s(A) = \frac{m - \sum_j a_{jj}}{m - 1} \in (0, 1) + + s(A) = \frac{m - \sum_j a_{jj} }{m - 1} \in (0, 1) An index equal to 0 indicates complete immobility. References ----------- - Wealth distribution and social mobility in the US: A quantitative approach - (Benhabib, Bisin, Luo, 2017). - https://www.econ.nyu.edu/user/bisina/RevisionAugust.pdf + .. [1] Wealth distribution and social mobility in the US: A quantitative approach + (Benhabib, Bisin, Luo, 2017). + https://www.econ.nyu.edu/user/bisina/RevisionAugust.pdf """ A = np.asarray(A) # Convert to array if not already diff --git a/quantecon/optimize/nelder_mead.py b/quantecon/optimize/nelder_mead.py index d0f7592a5..00e98dd91 100644 --- a/quantecon/optimize/nelder_mead.py +++ b/quantecon/optimize/nelder_mead.py @@ -25,8 +25,7 @@ def nelder_mead(fun, x0, bounds=np.array([[], []]).T, args=(), tol_f=1e-10, Parameters ---------- fun : callable - The objective function to be maximized. - `fun(x, *args) -> float` + The objective function to be maximized: `fun(x, *args) -> float` where x is an 1-D array with shape (n,) and args is a tuple of the fixed parameters needed to completely specify the function. This function must be JIT-compiled in `nopython` mode using Numba.