Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/sphinx-doc/sphinx.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJuan Luis Cano Rodríguez <hello@juanlu.space>2021-11-23 12:17:09 +0300
committerJuan Luis Cano Rodríguez <hello@juanlu.space>2021-11-23 12:17:09 +0300
commitd39c6861d9542064cfa0a10878b1ce7317994602 (patch)
tree12bf759d26b7c3ce660fddd922525ed35e2db4e0 /doc
parentdaceb8aba3b0d90beb5ad6c84d8187284c5932df (diff)
Add note about `.nojekyll` file
Diffstat (limited to 'doc')
-rw-r--r--doc/tutorial/deploying.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/tutorial/deploying.rst b/doc/tutorial/deploying.rst
index 85fc6643a..9f956a1f2 100644
--- a/doc/tutorial/deploying.rst
+++ b/doc/tutorial/deploying.rst
@@ -214,6 +214,15 @@ This contains a GitHub Actions workflow with a single job of four steps:
4. If the change happens on the default branch, take the contents of
``docs/build/html`` and push it to the ``gh-pages`` branch.
+.. note::
+
+ The ``actions-gh-pages`` takes care of adding a ``.nojekyll`` file to the
+ output `so that GitHub Pages doesn't process it with its default
+ static site generator`__. Alternatively, you can enable the
+ :py:mod:`sphinx.ext.githubpages` extension on your project.
+
+.. __: https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#static-site-generators
+
Next, you need to specify the dependencies for the ``make html`` step to be
successful. For that, create a file ``docs/requirements.txt`` and add the
following contents: