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

Uploaded Source

Built Distribution

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

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: sphinx_rtd_theme-1.2.0.tar.gz
  • Upload date:
  • Size: 2.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.12

File hashes

Hashes for sphinx_rtd_theme-1.2.0.tar.gz
Algorithm Hash digest
SHA256 a0d8bd1a2ed52e0b338cbe19c4b2eef3c5e7a048769753dac6a9f059c7b641b8
MD5 e05658f53b4274bbe0756671bc188181
BLAKE2b-256 35b440faec6790d4b08a6ef878feddc6ad11c3872b75f52273f1418c39f67cd6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_rtd_theme-1.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f823f7e71890abe0ac6aaa6013361ea2696fc8d3e1fa798f463e82bdb77eeff2
MD5 bcbdc92f2bcb68878db04ffddb59d2f7
BLAKE2b-256 b346c167351699e5dc126798385cf37c26ba9df7a26c6f8855661d9f966d6ced

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