diff options
Diffstat (limited to 'docs/installing.rst')
| -rw-r--r-- | docs/installing.rst | 26 |
1 files changed, 19 insertions, 7 deletions
diff --git a/docs/installing.rst b/docs/installing.rst index 7b78ee6..522b986 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -1,6 +1,5 @@ -************ Installation -************ +============ Install the package (or add it to your ``requirements.txt`` file): @@ -21,15 +20,28 @@ In your ``conf.py`` file: html_theme = "sphinx_rtd_theme" +.. seealso:: + :ref:`supported-browsers` + Officially supported and tested browser/operating system combinations + + :ref:`supported-dependencies` + Officially Supported versions of Python, Sphinx, and other dependencies. .. note:: - Adding this theme as an extension is what enables localization of theme - strings in your translated output. If these strings are not translated in - your output, either we lack the localized strings for your locale, or you - are using an old version of the theme. + + Adding this theme as an extension is what enables localization of theme + strings in your translated output. If these strings are not translated in + your output, either we lack the localized strings for your locale, or you + are using an old version of the theme. Via Git or Download -=================== +------------------- + +.. warning:: + + 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 |