This Sphinx extension adds a toggleable dark mode to the Read the Docs theme. A little icon is added in the bottom right hand corner which allows the user to switch between light or dark mode.

Python 3.4 or higher is required

To install dark mode for the RTD theme, enter the following command into your terminal or command prompt.

# Linux/OSX
python3 -m pip install sphinx-rtd-dark-mode

# Windows
py -3 -m pip install sphinx-rtd-dark-mode

To use the extension, you will need to add it to the extensions array in your config file (conf.py).

extensions = ["sphinx_rtd_dark_mode"]

You will also need to be using the Sphinx RTD theme for this to work. If your not, then the extension will change it for you as it only works for that theme.

Below are the options that are customizeable for the extension. Currently, there is only one option available to configure.

The Sphinx RTD Dark Mode module for Python is licensed under an MIT license.