How to upload html documentation generated from sphinx to github?

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.

How to publish sphinx-generated documentation on bitbucket wiki automatically?

I have a python package with sphinx-generated documentation (using the automodules feature) and it can be made into a set of static html pages sitting in a _build directory in the git repository of th

Migrating existing sphinx documentation to GitHub

I have a set of documentation for a Python package written using Sphinx. The documentation contains source and build/html directories, and a Makefile. So at the moment, if I add the documentation to a

Sphinx documentation in Django

I am currently integrating sphinx generated documentation in my Django app. I want documentation to extend my app templates. The HTML generated by Sphinx should look like this {% extends base.html %

How to create Github pages from a project’s documentation?

I have a project on Github that has a directory containing some automatically generated HTML documentation. I would like to use that documentation within Github’s project pages facility. So, I’ve read

sphinx – how to change documentation style sheet

I generated the Python documentation with sphinx to view it on Qt Assistant, but the theme used by the Python developers for their documentation seems to have some problems on Qt Assistant, Is there a

Sphinx Documentation Import error

I am new to sphinx documentation. I followed the sphinx documentation for configuring sphinx for my cherrypy project.But when I run make html it throws me lots of errors and warnings as follows: Trace

Sphinx python auto generated documentation failure

I would like to make a documentation for an API called Ulyxes PyAPI. I have already started it, but the auto-generation process is not working. When I click Automated Generated Document link in my ind

Python: Sphinx: How to include automatically all classes, methods and functions in a sphinx documentation? [duplicate]

Possible Duplicate: Sphinx — combining automodule and autoclass I try to create a html documentation for a project containing several thousand classes using sphinx and it’s autodoc plugin. sphinx-ap

including dynamic content in documentation generated by python-sphinx

I am using sphinx to generate documentation for my project, and building the documentation as part of the product’s install process. I would like to dynamically include the hostname in the text and/or

Sphinx HTML Python documentation hangs in web browser

Using a particularly fancy theme, the Sphinx-generated html webpages hang when loading in google chrome. Anyone familiar with this problem or have general advice for debugging it? I downloaded the the

Answers

github will serve 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://pages.github.com/.

You will likely run into an issue using Sphinx on github, because Sphinx uses directories with leading underscores. You can fix this by adding a file called .nojekyll in the the directory with the generated sphinx html.

github-tools has a feature doing exactly what you are asking for:

paver gh_pages_create gh_pages_build

Refer to the excellent documentation (of course using itself) for how to set it up for your project.

John Paulett’s answer is obviously correct and likely sufficient for most users already (+1).

Alternatively you might want to check out Ben Welsh’s thorough tutorial Sphinx documentation on GitHub, which provides step by step instructions as well as a convenient Fabric based script/task tying those together to get you started to Quickly publish documentation alongside your code […] via a single command.