-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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
Update Documentation #454
Conversation
@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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
the build of this branch is viewable: https://quanteconpy.readthedocs.io/en/update-docs/ |
@natashawatkins I tried a few things re: /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. |
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 |
I'll try double escaping |
Actually I just added a raw flag |
Update the documentation to include