Installation¶
This theme is distributed on PyPI and can be installed with pip
:
$ pip install sphinx-rtd-theme
To use the theme in your Sphinx project, you will need to add the following to
your conf.py
file:
import sphinx_rtd_theme
extensions = [
...
"sphinx_rtd_theme",
]
html_theme = "sphinx_rtd_theme"
For more information read the full documentation on installing the theme
Configuration¶
This theme is highly customizable on both the page level and on a global level. To see all the possible configuration options, read the documentation on configuring the theme.
Contributing¶
If you would like to help modify or translate the theme, you’ll find more information on contributing in our contributing guide.