Skip to content
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

Makefile command & script for GitHub Pages #239

Merged
2 commits merged into from Jan 23, 2011
Merged

Makefile command & script for GitHub Pages #239

2 commits merged into from Jan 23, 2011

Conversation

minrk
Copy link
Member

@minrk minrk commented Jan 3, 2011

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:

make gh-pages

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.

@ellisonbg
Copy link
Member

This looks fantastic and I think we should definitely host our docs at the github site. It makes it much easier for people other than Fernando to update the docs. Most of these changes are being used by other projects so this one should go right in.

This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants