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.
6 maintainers
Metadata
6 maintainers
Release files for sphinx-rtd-theme 3.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_rtd_theme-3.1.0.tar.gz | 7.6 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_rtd_theme-3.1.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 15.3 MB
Release files / sphinx_rtd_theme-3.1.0.tar.gz
| Download URL | sphinx_rtd_theme-3.1.0.tar.gz |
|---|---|
| Size | 7.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b44276f2c276e909239a4f6c955aa667aaafeb78597923b1c60babc76db78e4c
|
|
BLAKE2b-256 checksum How to use checksums |
8468a1bfbf38c0f7bccc9b10bbf76b94606f64acb1552ae394f0b8285bfaea25
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Release files / sphinx_rtd_theme-3.1.0-py2.py3-none-any.whl
| Download URL | sphinx_rtd_theme-3.1.0-py2.py3-none-any.whl |
|---|---|
| Size | 7.7 MB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
1785824ae8e6632060490f67cf3a72d404a85d2d9fc26bce3619944de5682b89
|
|
BLAKE2b-256 checksum How to use checksums |
87c7b5c8015d823bfda1a346adb2c634a2101d50bb75d421eb6dcb31acd25ebc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
