How to upload html documentation generated from sphinx to github?

Question

I just documented loads of my code and learnt how to use sphinx to generate the documentation. I want to include that into my github project page but I do not know how to. Does anyone know existing tutorial or simple step to do so?

Thanks.

Answer 1

I'm not completely confident that I understand your objectives, but here goes: Github has a standard way of including (project-) documentation on you github project pages, it uses markdown and github has an introduction to their use of markdown. If you add a file to your root level folder with markdown formatted text in it and name it something like README.markdown, github will pick it up, process it and display it on the page that displays the folder.

From what I understand from your question, this is not exactly what you wish to do? Github will not display your own html. You can store your rst-files in git just like any other git registered file, but github will not treat it in any special way. So: Either convert you rst to markdown (which I wouldn't recommend unless you can do it automatically) or upload your documentation another place and link to it.

Answer 2

github will server static content for you using their github pages feature. Essentially, you create a branch called gh-pages, into which you commit your static pages. The pages are then served at you.github.com/yourproject.

See the instructions at http://you.github.com/.

You will likely run into an issue using Sphinx on github, because Sphinx uses directories with leading underscores. There is a Sphinx extension, github-tools, which can help out fixing this issue.