https://github.com/proplot-dev/sphinx-rtd-light-dark

🐼 A clean variant of the read the docs theme with light-dark mode toggling
https://github.com/proplot-dev/sphinx-rtd-light-dark

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/proplot-dev/sphinx-rtd-light-dark
• Owner: proplot-dev
• License: mit
• Created: 2022-05-29T07:00:41.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-08-17T08:18:00.000Z (8 months ago)
• Last Synced: 2024-11-12T23:32:54.168Z (6 months ago)
• Language: CSS
• Homepage:
• Size: 26.4 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
Read the Docs Light-Dark Theme

------------------------------

[![pypi](https://img.shields.io/pypi/v/sphinx-rtd-light-dark?color=83%20197%2052)](https://pypi.org/project/sphinx-rtd-light-dark/)

[![licence](https://img.shields.io/github/license/lukelbd/sphinx-rtd-light-dark.svg)](LICENSE.txt)

A clean variant of the [read the docs theme](https://github.com/readthedocs/sphinx_rtd_theme)

with grayscale styling and optional light mode / dark mode toggling.

This theme is currently used with the [proplot](https://proplot.readthedocs.io)

and [climopy](https://climopy.readthedocs.io) 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`:

```python

extensions = [

  ...

  'sphinx_rtd_light_dark',

  ...

]

html_theme = 'sphinx_rtd_light_dark'

```