Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Use a githook to auto-generate sphinx documentation and dump it in your gh-pages before pushing
Python
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
source
.gitignore
Makefile
README.md

README.md

sphinx-github-githook!

First:

My plan is to find a good way to auto-generate and push sphinx-generated documentation to github on pushes to master.

Issues so far:

  • pages.github.com doesn't like sphinx's underscored folders due to jekyll trying to process them.
  • the hook is so far EXTREMELY tempermental because it doesn't really have any way of dealing with unexpected behavior.
  • I think a lot of this can be mitigated by "priming" the gh-pages branch, so to speak.
  • the githook doesn't actually seem to be running, at least as a githook. Works okay as a stand-alone script.
  • I don't know RST.
Something went wrong with that request. Please try again.