Small fixes

This commit is contained in:
Anthony Johnson
2021-08-17 14:34:25 -06:00
parent 022a58f68e
commit bdd49c4eb3
2 changed files with 6 additions and 5 deletions

View File

@@ -90,7 +90,7 @@ version:
.. code:: console
% pip install "sphinx_rtd_theme<=2.0.0"
$ pip install "sphinx_rtd_theme<=2.0.0"
.. _semantic versioning: http://semver.org/
@@ -111,7 +111,7 @@ it resolves bugs with the latest release of Docutils, version 0.17.
Starting with this release, several deprecation warnings will be emitted at
build time:
Direction installation is deprecated
Direct installation is deprecated
Support for direct installation through GitHub is no longer a suggested
installation method. In an effort to ease maintenance, compiled assets will
eventually be removed from the theme repository. These files will only be

View File

@@ -35,12 +35,13 @@ In your ``conf.py`` file:
are using an old version of the theme.
Via Git or Download
===================
-------------------
.. warning::
Installing directly from the repo is deprecated.
Static assets won't be included in the repo in a future release.
Installing directly from the repository source is deprecated and is not
recommended. Static assets won't be included in the repository starting in
release :ref:`3.0.0`.
Symlink or subtree the ``sphinx_rtd_theme/sphinx_rtd_theme`` repository into your documentation at
``docs/_themes/sphinx_rtd_theme`` then add the following two settings to your Sphinx