Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Documentation #454

Merged
merged 8 commits into from
Dec 13, 2018
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Makefile for Sphinx documentation
# Makefile for Sphinx documentation
#

# You can set these variables from the command line.
Expand Down
1 change: 1 addition & 0 deletions docs/source/game_theory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions docs/source/game_theory/repeated_game.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
repeated_game
=============

.. automodule:: quantecon.game_theory.repeated_game
:members:
:undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions docs/source/optimize.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ Optimize
.. toctree::
:maxdepth: 2

optimize/nelder_mead
optimize/root_finding
optimize/scalar_maximization
7 changes: 7 additions & 0 deletions docs/source/optimize/nelder_mead.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
nelder_mead
===========

.. automodule:: quantecon.optimize.nelder_mead
:members:
:undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions docs/source/tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Tools
tools/filter
tools/graph_tools
tools/gridtools
tools/inequality
tools/ivp
tools/kalman
tools/lae
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Inquality
inequality
==========

.. automodule:: quantecon.inquality
.. automodule:: quantecon.inequality
:members:
:undoc-members:
:show-inheritance:
13 changes: 7 additions & 6 deletions quantecon/inequality.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down Expand Up @@ -73,8 +73,8 @@ def gini_coefficient(y):

References
----------
.. [1] https://en.wikipedia.org/wiki/Gini_coefficient

https://en.wikipedia.org/wiki/Gini_coefficient
"""
n = len(y)
i_sum = np.zeros(n)
Expand Down Expand Up @@ -106,10 +106,11 @@ def shorrocks_index(A):
An index equal to 0 indicates complete immobility.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@natashawatkins could you check this math equation. It seems to be breaking on the html build.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How can I actually build the docs myself because I was having problems when I followed the instructions?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if you cd docs and run make html it should build to build/html and then you can run python -m http.server for viewing locally. Otherwise I have enabled rtd to render this branch.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm getting an error that I noted in #460


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] Benhabib, Bison, and Luo, Wealth distribution and social mobility
in the US: A quantitative approach (2017), https://www.econ.nyu.edu/user/bisina/RevisionAugust.pdf

"""

A = np.asarray(A) # Convert to array if not already
Expand Down
3 changes: 1 addition & 2 deletions quantecon/optimize/nelder_mead.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down