Skip to content

Instantly share code, notes, and snippets.

@arthurk
Created March 6, 2010 13:25
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save arthurk/323673 to your computer and use it in GitHub Desktop.
Save arthurk/323673 to your computer and use it in GitHub Desktop.
Hosting Sphinx docs at GitHub
-----------------------------
Before: Run sphinx-quickstart in docs/
1. Follow "Project Pages" instructions from http://pages.github.com/ to create a gh-pages branch
2. Add Sphinx html build dir as git submodule:
git checkout master
git submodule add -b gh-pages git@github.com:arthurk/django-disqus.git docs/_build/html
Note: Use full url, not relative paths.
git commit -m "added gh-pages submodule"
git push
git submodule init
4. cd docs/ && make html
5. cd _build/html/ && touch .nojekyll
6. git add .
git commit -m "generated docs"
git push origin gh-pages
7. cd ../../../
git commit -a -m "build documentation"
git push origin master
Sources:
http://blog.blindgaenger.net/generate_github_pages_in_a_submodule.html
http://pypi.python.org/pypi/github-tools
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment