Skip to content

Commit 768dcc1

Browse files
humitosagjohnson
andauthored
Docs: update the installation note (#1595)
* Docs: update the installation note Translated string work with/without the theme added into the ``extensions``. However, it's still required to be inside the extensions because of ``sphinxcontrib-jquery``. I'm keeping the note, but changing it content. * Update docs/installing.rst Co-authored-by: Anthony <[email protected]> --------- Co-authored-by: Anthony <[email protected]>
1 parent 2c19bb1 commit 768dcc1

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

docs/installing.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,13 @@ In your Sphinx project's ``conf.py`` file, add ``sphinx_rtd_theme`` to the list
3131

3232
.. note::
3333

34-
Adding this theme as an extension is what enables localization of theme
35-
strings in your translated output. If these strings are not translated in
36-
your output, either we lack the localized strings for your locale, or you
37-
are using an old version of the theme.
38-
39-
..
40-
comment about this note: it's possibly not necessary to add the theme as an extension.
41-
Rather, this is an issue caused by setting html_theme_path.
42-
See: https://github.com/readthedocs/readthedocs.org/pull/9654
34+
Adding this theme as an extension activates the ``sphinxcontrib-jquery`` extension,
35+
which is required for search, smooth scrolling, and the flyout menu.
36+
If any of these features don't work, make sure you have the theme declared in your ``extensions``.
37+
38+
.. More context for this note:
39+
* https://github.com/readthedocs/sphinx_rtd_theme/issues/1434#issuecomment-2288359582
40+
* https://github.com/readthedocs/sphinx_rtd_theme/issues/1222#issuecomment-2296703160
4341
4442
4543
.. _howto_upgrade:

0 commit comments

Comments
 (0)