Sphinx_rtd_theme
| Project Name | Stars | Downloads | Repos Using This | Packages Using This | Most Recent Commit | Total Releases | Latest Release | Open Issues | License | Language |
|---|---|---|---|---|---|---|---|---|---|---|
| Sphinx_rtd_theme | 4,371 | | 2,004 | 4,040 | 4 days ago | 32 | September 13, 2021 | 242 | mit | Sass |
| Sphinx theme for readthedocs.org | ||||||||||
| Furo | 1,813 |  | 344 | 6 days ago | 61 | June 21, 2022 | 21 | mit | Sass | |
| A clean customizable documentation theme for Sphinx | ||||||||||
| Www | 1,205 | 6 days ago | 51 | other | ||||||
| The main website for Write the Docs. | ||||||||||
| Sphinx_fossasia_theme | 1,093 | 3 years ago | 4 | August 01, 2017 | 8 | gpl-3.0 | HTML | |||
| Theme for Sphinx/Yaydoc | ||||||||||
| Sphinx_phimpme_theme | 1,078 | 6 years ago | gpl-3.0 | HTML | ||||||
| Sphinx Phimpme Theme | ||||||||||
| Sublime Undocs | 600 | 3 years ago | 46 | other | Python | |||||
| Sublime Text Unofficial Documentation | ||||||||||
| Sphinx Bootstrap Theme | 578 |  | 488 | 112 | a year ago | 58 | February 03, 2022 | 54 | mit | HTML |
| Sphinx Bootstrap Theme | ||||||||||
| Sphinx Book Theme | 329 |  | 165 | a month ago | 61 | July 17, 2022 | 62 | bsd-3-clause | Jupyter Notebook | |
| A clean book theme for scientific explanations and documentation with Sphinx | ||||||||||
| Sphinx Material | 274 |  | 4 | 40 | 4 months ago | 32 | October 06, 2021 | 32 | other | CSS |
| A material-based, responsive theme inspired by mkdocs-material | ||||||||||
| Sphinx Themes.org | 175 | a month ago | 8 | bsd-2-clause | Python | |||||
| A showcase for Sphinx documentation themes | ||||||||||
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.
