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

Uploaded Source

Built Distribution

sphinx_rtd_theme-1.0.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.0.0.tar.gz.

File metadata

  • Download URL: sphinx_rtd_theme-1.0.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.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.5

File hashes

Hashes for sphinx_rtd_theme-1.0.0.tar.gz
Algorithm Hash digest
SHA256 eec6d497e4c2195fa0e8b2016b337532b8a699a68bcb22a512870e16925c6a5c
MD5 fdfc7d2e102cb96eca0f6155dde7403e
BLAKE2b-256 1c32580309c9fd5b1892c6616ce814710c6b14423e98bf1c101bf2c710433cee

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_rtd_theme-1.0.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.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.5

File hashes

Hashes for sphinx_rtd_theme-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4d35a56f4508cfee4c4fb604373ede6feae2a306731d533f409ef5c3496fdbd8
MD5 98a94c3e7ff439b17bbf3ed5882fc99e
BLAKE2b-256 e0d23818e4730e314719e27f639c44164419e40eed826d63753dc480262036e8

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