Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
New project domain: pycalphad.org #47
This might be a good excuse to move off of RTD for good, especially since it is still before the first pycalphad paper has been submitted (so we can change the docs URL etc.)
@bocklund Have you made any progress with Travis-CI and gh-pages integration?
There are a couple ways to generate Sphinx docs and push them onto a gh-pages branch. RTD has an advantage in being able track documentation for multiple branches, which I haven't seen recreated in any gh-pages implementation I've come across.
I think that it could be possible that two sets of docs could be maintained, but it would require a bit of clever template writing in Sphinx that I haven't looked into. My idea would be to have the master and develop branches build to two sub directories (e.g. repo/stable and repo/latest, similar to RTD) have a link on each page that would send you to the opposing docs. So each link would replace the 'stable' or 'latest' to the opposing one. For example, the page
Again, I'm not sure if it's possible, but I think it is a good starting point if we want to try and publish multiple versions of the docs on gh-pages.
Promising approach for deploying to gh-pages (check the comments too):
We could easily change the
I definitely think the approach to credential management should be to create a machine GitHub account and generate a key pair for it. It's possible to configure that account to only have push access to the gh-pages branch of this repo.