Combination of few things to make Sphinx documentation working for my Github repository

sphinx-on-github.md

Combination of two great advices to make Sphinx documentation working for my project

** Author: ** Alex Liberzon http://github.com/alexlib

1. Followed the "grandparent" advice from https://gist.github.com/833223

• it means that we have openpiv-python/master and openpiv-python/gh-pages directories, each has its own .git structure and doesn't know one about another.

2. In the master branch, in the master/openpiv/docs/sphinx_docs a) echo "_build/" > .gitignore b) wrote simple Python script: http://bit.ly/ifRD9F

3. in the gh-pages I added: touch .nojekyll

From that moment and on the workflow is simple:

 git clone git@github.com:alexlib/openpiv-python
 cd openpiv-python
 python setup.py build
 python setup.py install
 cd openpiv/dos/examples/example1
 python example1.py 

So there is only one, /master branch is visible and working and all the rest of git great stuff works very smoothly. branch, switch, merge, no problem. Only one guy who holds the gh-pages repository (e.g. myself) will commit the documentation from time to time to get the updated online documentation.