sphinx-rtd-theme 1.2.0rc2

Read the Docs theme for Sphinx

This Sphinx theme was designed to provide a great reader experience for documentation users on both desktop and mobile devices. This theme is used primarily on Read the Docs but can work with any Sphinx project. You can find a working demo of the theme in the theme documentation

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 edit your conf.py file’s html_theme setting:

html_theme = "sphinx_rtd_theme"

See also:

Supported browsers

Officially supported and tested browser/operating system combinations

Supported dependencies

Supported versions of Python, Sphinx, and other dependencies.

Example documentation

A full example of this theme output, with localized strings enabled.

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.