-
Notifications
You must be signed in to change notification settings - Fork 80
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
Basic documentation for readthedocs #191
Conversation
And here's the rendered product! |
docs/index.rst
Outdated
* Follow `this feed`_ for updates on releases. | ||
* Check out the `github repository`_ . | ||
|
||
.. _this feed: https://github.com/choderalab/constph-openmm/releases.atom |
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.
Points to wrong repo here?
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.
Whoops, thanks!
What's the best way to include a list of authors/contributors? Is there some way to pull this in from github? |
This should be ready to merge now. The docstrings can probably use a lot of cleanup in a separate PR. |
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.
The docs look great!
I'm not very familiar with Sphinx so I can't comment on the scripts, but the documentation looks good!
$ bash ./Miniconda3-latest-Linux-x86_64.sh -b -p $HOME/miniconda3 | ||
$ export PATH="$HOME/miniconda3/bin:$PATH" | ||
|
||
On ``osx``, you want to use the ```osx`` binary |
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.
One ` too many
Once you go into an API page, there doesn't seem to be a link to click back into another part of the page. The user can press the back button in the browser but could be convenient to have the table of content link there like on the other, regular pages. Minor point, and not sure if this is easy to achieve. |
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.
Minor points only. Looks like the structure is there. We can refine the content as we go. Should be helpful.
These are docstring issues. The docstrings need some major cleanup, but that's beyond the scope of this PR.
That's exactly my hope.
I have no idea how to do this with sphinx, but if you can figure it out, that would make a great other PR. |
Merging this since I'm having trouble fixing the typos by pushing to this branch. |
This PR creates basic sphinx documentation for readthedocs.
Note that this required removing an earlier aborted attempt (which contained nothing useful).
Since so many files have changed, please just review the rendered docs and the updated README.