Closed rsheftel closed 6 years ago
Wow, thank you so much! Especially fixing the doc-strings is extremely helpful.
@twiecki all suggested changes have been made and all tests pass. If you decide to merge this and setup the docs on RTD, then you should change the link on the title of the empyrical to point to the RTD docs and not the GitHub pages. (I don't have access to change that)
Thanks @rsheftel!
This PR does the following:
For an example of how ReadTheDocs renders the documentation I connected my fork to RTD. The docs website is here: http://rsheftel-empyrical.readthedocs.io/en/latest/index.html (Note I left the project name "empyrical" free so that the official documentation can use that URL)
Note that to have RTD build the docs correctly you will need to make sure the following setting in the advanced are set:
And that is it. If the webhooks are set properly then every commit will regenerate the docs automatically.
If you need help with setting up RTD let me know. I believe you can add me as an administrator and I can help get it to work.
This replaces the pull request #22