Read the Docs theme for Sphinx
Project Links
Meta
Author: Dave Snider, Read the Docs, Inc. & contributors
Requires Python: >=3.8
Classifiers
Framework
- Sphinx
- Sphinx :: Theme
Development Status
- 5 - Production/Stable
License
- OSI Approved :: MIT License
Environment
- Console
- Web Environment
Intended Audience
- Developers
Programming Language
- Python :: 3
- Python :: 3 :: Only
- Python :: 3.8
- Python :: 3.9
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
Operating System
- OS Independent
Topic
- Documentation
- Software Development :: Documentation
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-themeTo 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"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.
3.0.2
Nov 13, 2024
3.0.1
Oct 09, 2024
3.0.0
Oct 07, 2024
3.0.0rc4
Oct 02, 2024
3.0.0rc3
Sep 26, 2024
3.0.0rc2
Sep 23, 2024
3.0.0rc1
Aug 20, 2024
2.1.0rc2
Aug 14, 2024
2.1.0rc1
Jul 23, 2024
2.0.0
Nov 28, 2023
2.0.0rc4
Oct 31, 2023
2.0.0rc3
Oct 24, 2023
2.0.0rc2
Aug 29, 2023
2.0.0rc1
Aug 21, 2023
1.3.0
Aug 21, 2023
1.3.0rc1
Aug 04, 2023
1.2.2
Jun 07, 2023
1.2.2rc1
Jun 07, 2023
1.2.1
May 23, 2023
1.2.0
Feb 07, 2023
1.2.0rc4
Feb 06, 2023
1.2.0rc3
Jan 18, 2023
1.2.0rc2
Jan 04, 2023
1.2.0rc1
Dec 16, 2022
1.1.1
Nov 04, 2022
1.1.0
Nov 01, 2022
1.1.0b3
Oct 13, 2022
1.1.0b2
Oct 12, 2022
1.1.0b1
Oct 12, 2022
1.0.0
Sep 13, 2021
1.0.0rc1
Aug 17, 2021
0.5.2
Apr 05, 2021
0.5.1
Jan 04, 2021
0.5.0
Jun 17, 2020
0.5.0rc2
Jun 05, 2020
0.5.0rc1
May 06, 2020
0.4.3
Feb 12, 2019
0.4.2
Oct 05, 2018
0.4.1
Jul 27, 2018
0.4.0
Jun 06, 2018
0.3.1
May 02, 2018
0.3.0
Apr 05, 2018
0.2.5b2
Dec 02, 2017
0.2.5b1
Apr 17, 2017
0.2.4
Mar 06, 2017
0.2.3
Mar 06, 2017
0.2.2
Mar 03, 2017
0.2.1
Mar 03, 2017
0.2.0
Mar 01, 2017
0.1.10b0
Feb 22, 2017
0.1.10a0
Jun 14, 2016
0.1.9
Sep 15, 2015
0.1.8
May 04, 2015
0.1.7
Mar 09, 2015
0.1.6
Mar 28, 2014
0.1.5
Nov 07, 2013
0.1.4
Nov 04, 2013
0.1.3
Nov 04, 2013
0.1.2
Nov 04, 2013
0.1.1
Nov 04, 2013
