Makefile command & script for GitHub Pages #239
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
GitHub has support for a special
gh-pages
website repo. You can use it to host Sphinx docs, and a sphinxtogithub extension is included to resolve small naming conflicts between sphinx and GitHub's use of jekyll.I wrote a script for pushing sphinx docs to GitHub, and added a
gh-pages
command to the Makefile, so simply running:will push the sphinx html docs to the gh-pages branch, which is accessible at <user_or_org>.github.com/. For example: http://minrk.github.com/ipython has the output of running that in my fork.
I know that with the current hosting, the official docs are frequently offline or at least super slow, so maybe this will help.