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

This version

1.1.0

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.0.tar.gz (2.8 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: sphinx_rtd_theme-1.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 6e20f00f62b2c05434a33c5116bc3348a41ca94af03d3d7d1714c63457073bb3
MD5 ada244702564626bd400dfba7afe25bf
BLAKE2b-256 32889a7fdcce940c9d2a1b22179e98b465218c2ed8a4f431d713d3925e597e0f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_rtd_theme-1.1.0-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.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 36da4267c804b98197419df8aa415d245449b8945301fce8c961038e0ba79ec5
MD5 e557ac2a04cbb5e134639017cdd31891
BLAKE2b-256 1437a0ce7e0bd1338ab9384fa8189a6b7902043696532b4258b224746812ec41

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