Metadata-Version: 2.1
Name: sphinx_rtd_dark_mode
Version: 1.2.2
Summary: Dark mode for the Sphinx Read the Docs theme.
Home-page: https://github.com/MrDogeBro/sphinx_rtd_dark_mode
Author: MrDogeBro
License: MIT
Download-URL: https://github.com/MrDogeBro/sphinx_rtd_dark_mode/archive/v1.2.2.tar.gz
Description: # Sphinx RTD Theme Dark Mode
        
        [![PyPi version](https://img.shields.io/pypi/v/sphinx-rtd-dark-mode.svg)](https://pypi.python.org/pypi/sphinx-rtd-dark-mode/) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/sphinx-rtd-dark-mode.svg)](https://pypi.python.org/pypi/sphinx-rtd-dark-mode/) [![](https://img.shields.io/github/license/MrDogeBro/sphinx_rtd_dark_mode.svg)](https://github.com/MrDogeBro/sphinx_rtd_dark_mode/blob/main/LICENSE)
        
        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
        # Linux/OSX
        python3 -m pip install sphinx-rtd-dark-mode
        
        # Windows
        py -3 -m pip install sphinx-rtd-dark-mode
        ```
        
        ## 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 = ["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.
        
        ## 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/MrDogeBro/sphinx_rtd_dark_mode/blob/master/LICENSE).
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.4
Description-Content-Type: text/markdown
