Skip to main content

A clean variant of the read the docs sphinx theme with light and dark modes.

Project description

Read the Docs Light-Dark Theme

A clean variant of the read the docs theme with grayscale styling and optional light mode / dark mode toggling. This theme is currently used with the proplot and climopy projects. Please refer to the published proplot and climopy documentation for demonstrations of the theme.

Theme Usage

Install with pip install sphinx-rtd-light-dark. Then in your conf.py file, add the entry 'sphinx_rtd_light_dark' to the extensions list, and set html_theme to 'sphinx_rtd_light_dark'. Example conf.py:

extensions = [
  ...
  'sphinx_rtd_light_dark',
  ...
]
html_theme = 'sphinx_rtd_light_dark'

Project details


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_light_dark-0.1.2.tar.gz (9.1 kB view hashes)

Uploaded Source

Built Distribution

sphinx_rtd_light_dark-0.1.2-py3-none-any.whl (9.8 kB view hashes)

Uploaded Python 3

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