Sign up
readthedocs
/
sphinx_rtd_theme

Public
Sphinx theme for readthedocs.org
sphinx-rtd-theme.readthedocs.io/
View license
3.9k stars
1.6k forks
Star
Notifications
master
Go to file
README.rst
Read the Docs Sphinx Theme

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.
Releases
23 tags
Used by 16
+ 8
Contributors 104
+ 93 contributors
Languages
© 2021 GitHub, Inc.
Terms
Privacy
Security
Status
Docs
Contact GitHubPricingAPITrainingBlogAbout
CodeCodeIssuesIssues119Pull requestsPull requests68ActionsActionsProjectsProjects2WikiWikiSecuritySecurityInsightsInsights Code Issues Pull requests Actions Projects Wiki Security Insights