mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-10-14 17:32:12 -05:00
Remove note to simplify message
This commit is contained in:
1 parent
d39c6861d9
commit
f6a3d037f4
1 file changed
-9
@@ -214,15 +214,6 @@ 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:
|
||||
|
||||
Reference in new issue
Block a user