https://github.com/scalabli/secretum_sphinx_theme

https://github.com/scalabli/secretum_sphinx_theme

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/scalabli/secretum_sphinx_theme
• Owner: scalabli
• License: mit
• Created: 2022-02-04T21:36:10.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-12T10:16:27.000Z (almost 3 years ago)
• Last Synced: 2024-11-14T10:50:46.390Z (about 2 months ago)
• Language: CSS
• Size: 18.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Secretum Sphinx RTD Theme Dark Mode

[![PyPi version](https://img.shields.io/pypi/v/secretum-sphinx-theme.svg)](https://pypi.python.org/pypi/secretum-sphinx-theme/) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/secretum-sphinx-theme.svg)](https://pypi.python.org/pypi/secretum-sphinx-theme/) [![PyPI download month](https://img.shields.io/pypi/dm/secretum-sphinx-theme.svg)](https://pypi.python.org/pypi/secretum-sphinx-theme/)

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.

## Installation

**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.

```bash

# pip install secretum-sphinx-theme

```

## Using the Extension

To use the extension, you will need to add it to the extensions array in your config

file (`conf.py`).

```py

extensions = ["secretum_sphinx_theme"]

```

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.

## Config

Below are the options that are customizeable for the extension. Currently, there

is only one option available to configure.

#### Default Dark Mode

This lets you choose which theme the user sees when they load the docs for the first

time ever. After the first time however, this setting has no effect as the users

preference is stored in local storage within their browser. This option accepts a

boolean for the value. If this option is true (the default option), users will start

in dark mode when first visiting the site. If this option is false, users will start

in light mode when they first visit the site.

```py

# user starts in dark mode

default_dark_mode = True

# user starts in light mode

default_dark_mode = False

```

## License

The Sphinx RTD Dark Mode module for Python is licensed under an [MIT license](https://github.com/scalabli/secretum_sphinx_theme/blob/main/LICENSE).