diff options
| author | Robert Lehmann <mail@robertlehmann.de> | 2010-12-09 10:44:31 +0100 |
|---|---|---|
| committer | Robert Lehmann <mail@robertlehmann.de> | 2010-12-09 10:44:31 +0100 |
| commit | 4a2ce98cd807e7dfd9c65b05ba1676ae246e399c (patch) | |
| tree | cc50d017c36b8dea66121634aa5206ba46b981db | |
| parent | e38f19a829862cf2880d27efaf431c875eb355e4 (diff) | |
| download | sphinx-git-4a2ce98cd807e7dfd9c65b05ba1676ae246e399c.tar.gz | |
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
| -rw-r--r-- | doc/faq.rst | 9 |
1 files 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 - <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: |