sphinx documentation and github

10 Feb 2010 \\ python 

So, there's tools out there to get your documentation up on github (github-tools, sphinx-to-github), but neither totally jive with how I want to do things. So, I went searching long and hard for a way to:

  • keep the document-generating source in master
  • place the generated html in gh-pages, so it's served as static html
  • have everything just "work"

Luckily, I came across this post which gets you most of the way there (but assumes you're using jekyll, which isn't the case for me/us).

So…

navigation:

interesting projects: