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.2

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

Uploaded Source

Built Distribution

sphinx_rtd_theme-1.2.2-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.2.2.tar.gz.

File metadata

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

File hashes

Hashes for sphinx_rtd_theme-1.2.2.tar.gz
Algorithm Hash digest
SHA256 01c5c5a72e2d025bd23d1f06c59a4831b06e6ce6c01fdd5ebfe9986c0a880fc7
MD5 ea90571ea4ffb546d419c05faf86a838
BLAKE2b-256 66867b2c3d15f44cb3ea2e1c54481494121d755081aa57a8076de3fa2be4d587

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for sphinx_rtd_theme-1.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6a7e7d8af34eb8fc57d52a09c6b6b9c46ff44aea5951bc831eeb9245378f3689
MD5 b1aa7b0e50307fbd761359d8d17f289e
BLAKE2b-256 85329ccebf3a82c085e8fc12b67cc3dbf840789fb6c7835ed0d61686d6509aa9

See more details on using hashes here.

Provenance

Supported by

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