Skip to content

🐼 A clean variant of the read the docs theme with light-dark mode toggling

License

Notifications You must be signed in to change notification settings

proplot-dev/sphinx-rtd-light-dark

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 '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'

About

🐼 A clean variant of the read the docs theme with light-dark mode toggling

Resources

License

Stars

Watchers

Forks

Packages

No packages published