Skip to main content

Read the Docs theme for Sphinx

Project description

Pypi Version Build Status License Documentation Status

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"

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.

Project details


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

sphinx_rtd_theme-1.1.0b3.tar.gz (2.8 MB view details)

Uploaded Source

Built Distribution

sphinx_rtd_theme-1.1.0b3-py2.py3-none-any.whl (2.8 MB view details)

Uploaded Python 2Python 3

File details

Details for the file sphinx_rtd_theme-1.1.0b3.tar.gz.

File metadata

  • Download URL: sphinx_rtd_theme-1.1.0b3.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.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.10

File hashes

Hashes for sphinx_rtd_theme-1.1.0b3.tar.gz
Algorithm Hash digest
SHA256 3f8681929c8ba6717fc388dae1ca03d45ff1ebe81617820f8548dcd01a49189c
MD5 cf9eef4223feff6309af8d995878d44a
BLAKE2b-256 ddaaab144f7209699a2ff1f3ea62015e4d04cb88538697d2605fce49951a6079

See more details on using hashes here.

File details

Details for the file sphinx_rtd_theme-1.1.0b3-py2.py3-none-any.whl.

File metadata

  • Download URL: sphinx_rtd_theme-1.1.0b3-py2.py3-none-any.whl
  • Upload date:
  • Size: 2.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.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.10

File hashes

Hashes for sphinx_rtd_theme-1.1.0b3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a3997fcc107ec3ef30d8766e22e188ed6f3ca99494bcaf16d7ad4c132ebcea39
MD5 5dd9b48da9dc2bba0fd3a286434d87a7
BLAKE2b-256 d4524387448e86fdb811ed7ad09387e034a1c4b92c320833299c30460a601997

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page