Read the Docs theme for Sphinx
Project description
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 add the following to your conf.py file:
import sphinx_rtd_theme
extensions = [
...
"sphinx_rtd_theme",
]
html_theme = "sphinx_rtd_theme"For more information read the full documentation on installing the 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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinx_rtd_theme-0.5.0rc2.tar.gz.
File metadata
- Download URL: sphinx_rtd_theme-0.5.0rc2.tar.gz
- Upload date:
- Size: 2.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0295bc054d2160eaffdb5fe32f58e2383e40c52949ab9d90941b6d81cfe5462b |
|
| MD5 | e076c9e4d0605c460ce9ab9811c5878b |
|
| BLAKE2b-256 | a3f26db7e171ca795cf12659d15e973d658f5642e2a1d0adc52f65cc9d14a029 |
Provenance
File details
Details for the file sphinx_rtd_theme-0.5.0rc2-py2.py3-none-any.whl.
File metadata
- Download URL: sphinx_rtd_theme-0.5.0rc2-py2.py3-none-any.whl
- Upload date:
- Size: 10.8 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 03c3d98933ca611dbde19d6e307b554b069f5214b659563d2a240de1a9fff5b0 |
|
| MD5 | 7ce890de5d71730f58e3caf2abf27066 |
|
| BLAKE2b-256 | f5ed94b22596e0b26347efad7c25a9fdac2e0ab8d6c1a01c91715b5ed81d2cc9 |
