diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2019-07-07 17:24:45 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-07-07 17:24:45 +0900 |
| commit | 96fa46e7b36a4f7571169a76b42fffb547702952 (patch) | |
| tree | 361413300498fe2a1adb8980db79c8a06bb06dda | |
| parent | 8782e50eae8a0f9edcf5feb917c6d8c7abe6b492 (diff) | |
| parent | 10883c2824ced4c9382d6c180fa75bc615513926 (diff) | |
| download | sphinx-git-96fa46e7b36a4f7571169a76b42fffb547702952.tar.gz | |
Merge pull request #6557 from tk0miya/update_faq
docs: Update FAQ for github pages
| -rw-r--r-- | doc/faq.rst | 7 |
1 files 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 - <https://github.com/blog/572-bypassing-jekyll-on-github-pages>`_ 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 |