Robert Lehmann  committed 16dd975

Recommend best practice instead of sphinx-to-github.

Reported by the original author, Michael Jones, on sphinx-dev.

  • Participants
  • Parent commits 2f1a3a7
  • Branches default

Comments (0)

Files changed (1)

    Sphinx documentation to the PyPI package documentation area at
-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: