Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: update sphinx.rst to reflect the default theme change

We don't default to Read The Docs anymore; update the docs to match.

Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

+5 -11
+5 -11
Documentation/doc-guide/sphinx.rst
··· 147 147 format-specific subdirectories under ``Documentation/output``. 148 148 149 149 To generate documentation, Sphinx (``sphinx-build``) must obviously be 150 - installed. For prettier HTML output, the Read the Docs Sphinx theme 151 - (``sphinx_rtd_theme``) is used if available. For PDF output you'll also need 152 - ``XeLaTeX`` and ``convert(1)`` from ImageMagick 153 - (https://www.imagemagick.org).\ [#ink]_ 154 - All of these are widely available and packaged in distributions. 150 + installed. For PDF output you'll also need ``XeLaTeX`` and ``convert(1)`` 151 + from ImageMagick (https://www.imagemagick.org).\ [#ink]_ All of these are 152 + widely available and packaged in distributions. 155 153 156 154 To pass extra options to Sphinx, you can use the ``SPHINXOPTS`` make 157 155 variable. For example, use ``make SPHINXOPTS=-v htmldocs`` to get more verbose ··· 158 160 It is also possible to pass an extra DOCS_CSS overlay file, in order to customize 159 161 the html layout, by using the ``DOCS_CSS`` make variable. 160 162 161 - By default, the build will try to use the Read the Docs sphinx theme: 162 - 163 - https://github.com/readthedocs/sphinx_rtd_theme 164 - 165 - If the theme is not available, it will fall-back to the classic one. 166 - 163 + By default, the "Alabaster" theme is used to build the HTML documentation; 164 + this theme is bundled with Sphinx and need not be installed separately. 167 165 The Sphinx theme can be overridden by using the ``DOCS_THEME`` make variable. 168 166 169 167 There is another make variable ``SPHINXDIRS``, which is useful when test