From 10883c2824ced4c9382d6c180fa75bc615513926 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 7 Jul 2019 16:08:54 +0900 Subject: [PATCH] docs: Update FAQ for github pages --- doc/faq.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/doc/faq.rst b/doc/faq.rst index 5ed8795f6..a46d46216 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -74,10 +74,9 @@ PyPI https://pythonhosted.org/. 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. + Please add :py:mod:`sphinx.ext.githubpages` to your project. It allows you + to publish your document in GitHub Pages. It generates helper files for + GitHub Pages on building HTML document automatically. MediaWiki See https://bitbucket.org/kevindunn/sphinx-wiki/wiki/Home, a project by