Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?


Failed to load latest commit information.
Latest commit message
Commit time
August 18, 2021 14:10
November 28, 2023 10:00
May 24, 2023 17:16
December 18, 2018 14:45
October 14, 2022 21:03
June 7, 2023 15:27
November 28, 2023 10:00
November 28, 2023 10:00

Read the Docs Sphinx Theme

Pypi Version Build Status License Documentation Status

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


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 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.


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.


If you would like to help modify or translate the theme, you'll find more information on contributing in our contributing guide.