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

Update Documentation #454

merged 8 commits into from
Dec 13, 2018

Conversation

mmcky
Copy link
Contributor

@mmcky mmcky commented Dec 11, 2018

Update the documentation to include

  • inequality
  • nelder mead (source)
  • repeated_game (source)

@coveralls
Copy link

coveralls commented Dec 11, 2018

Coverage Status

Coverage remained the same at 94.553% when pulling c003191 on update-docs into ab0c261 on master.

@rht
Copy link
Contributor

rht commented Dec 11, 2018

@mmcky https://travis-ci.org/QuantEcon/QuantEcon.py/jobs/466292136 is the test flake I encountered. It is indeed non-deterministic? The nelder mead code is recent, isn't it?

@@ -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

@mmcky
Copy link
Contributor Author

mmcky commented Dec 11, 2018

the build of this branch is viewable: https://quanteconpy.readthedocs.io/en/update-docs/

@mmcky
Copy link
Contributor Author

mmcky commented Dec 11, 2018

thanks @rht. @QBatista can you take a look at the issue with nelder_mead test?

@mmcky
Copy link
Contributor Author

mmcky commented Dec 11, 2018

@natashawatkins I tried a few things re: sharrock but there are still issues with the build.

/home/mmcky/anaconda3/lib/python3.6/site-packages/quantecon-0.4.2-py3.6.egg/quantecon/inequality.py:docstring of quantecon.inequality.shorrocks_index:34: WARNING: Error in "rubric" directive:
no content permitted.

.. rubric:: References

    .. [R23] 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

If you can take a look at the RST that would be great.

@natashawatkins
Copy link
Member

I think the above should have fixed it, but I can't test because docs won't compile

I'm not sure about the math error - it renders perfectly fine in latex

@natashawatkins
Copy link
Member

I'll try double escaping \f since it seems to have a problem with that

@natashawatkins
Copy link
Member

Actually I just added a raw flag

@mmcky mmcky merged commit c6ea72f into master Dec 13, 2018
@mmcky mmcky deleted the update-docs branch December 17, 2018 05:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants