Skip to content

README.md

Latest commit

 

History

History
29 lines (23 loc) · 1003 Bytes

README.md

File metadata and controls

29 lines (23 loc) · 1003 Bytes

Read the Docs Light-Dark Theme

pypi licence

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.

Theme Usage

Install with pip install sphinx-rtd-light-dark. Then in your conf.py file, add the entry 'ultraplot_theme' to the extensions list, and set html_theme to 'ultraplot_theme'. The legacy extension/theme name 'sphinx_rtd_light_dark' remains supported.

Example conf.py:

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