Open jchodera opened 10 years ago
So we currently have automated docs on readthedocs. They aren't up to date because we've been doing all development work in the nk
branch, rather than master.
Eventually we may need a more sophisticated solution, but we can probably do that in the same PR where we update the docs.
Shoot, I missed the link to the readthedocs. Is it in the README.md somewhere?
I just snagged pymbar.org
We could also do something like choderalab.org/software/pymbar
, in case we want to avoid having to buy lots of different domains.
Or http://pymbar.choderalab.org
We'll try http://pymbar.org for now, I think. Later on, we can consolidate into something more sensible.
I'm still not clear if the current master branch has docs pushed to readthedocs
right now. There isn't a link in the README.md
if so. Could we add one?
Also, if we need to add an S3 bucket instead, we can do that too.
Let me know where I should have http://pymbar.org point to.
For reference, our other S3 buckets are listed here (private): https://github.com/choderalab/choderalab/wiki/S3-Bucket-access
OK, I directly edited the README.md files in both the master and nk branches with links to read the docs.
Great! I've just changed http://pymbar.org to redirect to http://pymbar.readthedocs.org/en/latest/.
We should probably add a link back to the GitHub in the docs at some point.
Apologies if this is a duplicate, but I think we want to automatically build and upload the docs to an S3 bucket.
I think @pgrinaway may have set a bucket up already.
I can grab pymbar.org if we think this will be helpful!