Recommend best practice instead of sphinx-to-github.

Reported by the original author, Michael Jones, on sphinx-dev.
http://groups.google.com/group/sphinx-dev/msg/1faa6adbe1bf0819
This commit is contained in:
Robert Lehmann 2010-12-09 10:44:31 +01:00
parent e38f19a829
commit 4a2ce98cd8

View File

@ -60,10 +60,11 @@ PyPI
Sphinx documentation to the PyPI package documentation area at
http://packages.python.org/.
github pages
You can use `Michael Jones' sphinx-to-github tool
<http://github.com/michaeljones/sphinx-to-github/tree/master>`_ to prepare
Sphinx HTML output.
GitHub Pages
Directories starting with underscores are ignored by default which breaks
static files in Sphinx. GitHub's preprocessor can be `disabled
<https://github.com/blog/572-bypassing-jekyll-on-github-pages>`_ to support
Sphinx HTML output properly.
Google Analytics
You can use a custom ``layout.html`` template, like this: