From 4a2ce98cd807e7dfd9c65b05ba1676ae246e399c Mon Sep 17 00:00:00 2001 From: Robert Lehmann Date: Thu, 9 Dec 2010 10:44:31 +0100 Subject: [PATCH] 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 --- doc/faq.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/faq.rst b/doc/faq.rst index 0c2d2c4f7..c92067f0c 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -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 - `_ 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 + `_ to support + Sphinx HTML output properly. Google Analytics You can use a custom ``layout.html`` template, like this: