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

Uploaded Source

Built Distribution

sphinx_rtd_theme-1.2.0rc3-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.0rc3.tar.gz.

File metadata

  • Download URL: sphinx_rtd_theme-1.2.0rc3.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.2.0rc3.tar.gz
Algorithm Hash digest
SHA256 6d5c9534a0bff4f343c9f1c521848b5d9b1b12b842e3663d06668dd36fa7356a
MD5 59c5e07e01d16de556d645351a0e02cf
BLAKE2b-256 c9eb33531235359b5081c36271c9793e28d52347462ede2e0bf4f2f391b1f49b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_rtd_theme-1.2.0rc3-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.2.0rc3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6680809ba5794f6b39c4abd2766c7988c306a21aa5990a56d17b2d4b2dcb27b2
MD5 c2f5e7a0162a387479ce0082ca3d100b
BLAKE2b-256 966fc6e4a9efe74f23f4a9ecef3a8a54dbac684e1b952053e2bc81b9fea4b5c4

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