Skip to content

Commit 5ccab49

Browse files
rddunlapJonathan Corbet
authored andcommitted
docs: doc-guide: clarify latest theme usage
We have been using the Alabaster theme as the default theme since Sept. 2022. Keep the information on the RTD theme around in case someone wants to try it with the DOCS_THEME environment variable. Fixes: 26d797f ("docs: update sphinx.rst to reflect the default theme change") Signed-off-by: Randy Dunlap <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Cc: Mauro Carvalho Chehab <[email protected]> Reviewed-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Message-ID: <[email protected]>
1 parent c4941af commit 5ccab49

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Documentation/doc-guide/sphinx.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,6 @@ with your distributions. In order to do so, it is recommended to install
4242
Sphinx inside a virtual environment, using ``virtualenv-3``
4343
or ``virtualenv``, depending on how your distribution packaged Python 3.
4444

45-
.. note::
46-
47-
#) It is recommended to use the RTD theme for html output. Depending
48-
on the Sphinx version, it should be installed separately,
49-
with ``pip install sphinx_rtd_theme``.
50-
5145
In summary, if you want to install the latest version of Sphinx, you
5246
should do::
5347

@@ -162,6 +156,12 @@ By default, the "Alabaster" theme is used to build the HTML documentation;
162156
this theme is bundled with Sphinx and need not be installed separately.
163157
The Sphinx theme can be overridden by using the ``DOCS_THEME`` make variable.
164158

159+
.. note::
160+
161+
Some people might prefer to use the RTD theme for html output.
162+
Depending on the Sphinx version, it should be installed separately,
163+
with ``pip install sphinx_rtd_theme``.
164+
165165
There is another make variable ``SPHINXDIRS``, which is useful when test
166166
building a subset of documentation. For example, you can build documents
167167
under ``Documentation/doc-guide`` by running

0 commit comments

Comments
 (0)