Skip to content

Commit 0580798

Browse files
benjaomingBlendify
andauthored
Simplify example but add clarity. (#1144)
Some people might add the example code to the top of the file, in which case `alabaster` will overwrite later. Also, localization is important but not so important for people using this for the first time. My concern is that many people end up with Alabaster on RTD deployments after Sphinx 4 made it the default. Co-authored-by: Aaron Carlisle <[email protected]>
1 parent 392daf5 commit 0580798

File tree

1 file changed

+4
-10
lines changed

1 file changed

+4
-10
lines changed

README.rst

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,15 @@ This theme is distributed on PyPI_ and can be installed with ``pip``:
3333
3434
$ pip install sphinx-rtd-theme
3535
36-
To use the theme in your Sphinx project, you will need to add the following to
37-
your ``conf.py`` file:
36+
To use the theme in your Sphinx project, you will need to edit
37+
your ``conf.py`` file's ``html_theme`` setting:
3838

3939
.. code:: python
4040
41-
import sphinx_rtd_theme
42-
43-
extensions = [
44-
...
45-
"sphinx_rtd_theme",
46-
]
47-
4841
html_theme = "sphinx_rtd_theme"
4942
50-
For more information read the full documentation on `installing the theme`_
43+
For more information, including a full example with localized strings enabled,
44+
read the documentation on `installing the theme`_.
5145

5246
.. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme
5347
.. _installing the theme: https://sphinx-rtd-theme.readthedocs.io/en/latest/installing.html

0 commit comments

Comments
 (0)