mirror of
https://github.com/readthedocs/sphinx_rtd_theme.git
synced 2026-10-16 11:22:01 -05:00
Aaron Carlisle
114fb85b44
Sphinx 1.6 is required for de76c03824 we also do not test against versions lower than 1.6 so we should safely drop it.
This is similar to #1076 and #1075 but less strict
56 lines
1.3 KiB
ReStructuredText
56 lines
1.3 KiB
ReStructuredText
************
|
|
Installation
|
|
************
|
|
|
|
Install the package (or add it to your ``requirements.txt`` file):
|
|
|
|
.. code:: console
|
|
|
|
$ pip install sphinx_rtd_theme
|
|
|
|
In your ``conf.py`` file:
|
|
|
|
.. code:: python
|
|
|
|
import sphinx_rtd_theme
|
|
|
|
extensions = [
|
|
...
|
|
'sphinx_rtd_theme',
|
|
]
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
|
|
|
|
.. 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.
|
|
|
|
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.
|
|
|
|
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
|
|
``conf.py`` file:
|
|
|
|
.. code:: python
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_theme_path = ["_themes", ]
|
|
|
|
Compatibility
|
|
=============
|
|
|
|
``sphinx_rtd_theme`` depends on at least Sphinx 1.6 although,
|
|
we recommend at least Sphinx 2 to take advantage of the html5 writer.
|
|
The html4 writer is still supported however,
|
|
it is deprecated and support will be removed in the near future.
|