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

Uploaded Source

Built Distribution

sphinx_rtd_theme-1.2.1-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.1.tar.gz.

File metadata

  • Download URL: sphinx_rtd_theme-1.2.1.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.1.tar.gz
Algorithm Hash digest
SHA256 cf9a7dc0352cf179c538891cb28d6fad6391117d4e21c891776ab41dd6c8ff70
MD5 f5b94b5d1c43d4529031cc5099676e79
BLAKE2b-256 9a790b25a26c2103457553530c45d0f5408e3ca19c02274f170d86607d0b805c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for sphinx_rtd_theme-1.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2cc9351176cbf91944ce44cefd4fab6c3b76ac53aa9e15d6db45a3229ad7f866
MD5 b0ba61509f65f0f9731fda5010a77895
BLAKE2b-256 c273946cdd32f29c87843edaa059b9fc52ab9267d1137b3a76dee1d59d02a01a

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