sphinx-rtd-dark-mode
Dark mode for the Sphinx Read the Docs theme.
Decision gist · record as of 2026-08-14
Yes, if you use Sphinx with the Read the Docs theme and want to offer dark mode to your readers. Installation is straightforward, maintenance burden is minimal, and the permissive MIT license poses no legal risk. The dormant status is not a concern for a feature-complete extension; however, verify compatibility with your current sphinx-rtd-theme version before deploying to production.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.4 or higher and the sphinx-rtd-theme package to be installed and active in your Sphinx configuration.
- Low friction install with a single runtime dependency on sphinx-rtd-theme.
- Maintenance is dormant—last release was 2023-09-19 and no commits since 2023-09-22—but the package is marked Production/Stable and has received no security reports.
License · maintenance · safety
MIT (permissive) — MIT license is permissive; you can use this in commercial or private projects without restriction, though you must retain the license notice.
last release 2023-09-19 (1060 days) · last repo commit 2023-09-22 · 73 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 262,700 downloads/mo, #8,368 on PyPI
Alternatives
Verify before relying
pip install sphinx-rtd-dark-mode
# In conf.py:
extensions = ["sphinx_rtd_dark_mode"]
default_dark_mode = True # optional: users start in dark mode- Whether the dark mode toggle works correctly with recent versions of sphinx-rtd-theme, given the last commit was 2023-09-22.
- Whether browser local storage persistence of user preference works across all modern browsers.
What it is and what it does
This is a Sphinx extension that layers dark mode functionality onto the Read the Docs theme. When installed and added to your Sphinx conf.py, it injects a toggle button in the bottom right corner of your documentation site, letting readers switch between light and dark color schemes. The reader's choice is saved in their browser's local storage, so their preference persists across visits.
The extension is lightweight—it has only one runtime dependency, sphinx-rtd-theme—and requires minimal configuration. You can set a default mode (dark or light) for first-time visitors, but after that, the user's stored preference takes over. The package is marked Production/Stable and has been dormant since late 2023, suggesting it is feature-complete rather than actively developed.
Use it for
- Enable dark mode for technical documentation sites to reduce eye strain for readers working at night or in low-light environments.
- Provide accessibility-conscious documentation by offering both light and dark viewing modes without requiring server-side theme switching.
- Add a polished UX touch to Sphinx-based project documentation with minimal setup overhead.
- Let readers with visual sensitivity or preference for dark interfaces control their viewing experience without site configuration changes.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you use Sphinx with the Read the Docs theme and want to offer dark mode to your readers.
Installation is straightforward, maintenance burden is minimal, and the permissive MIT license poses no legal risk. The dormant status is not a concern for a feature-complete extension; however, verify compatibility with your current sphinx-rtd-theme version before deploying to production.
Install
sphinx-rtd-dark-mode on PyPI
Before you install
Low friction install with a single runtime dependency on sphinx-rtd-theme. Maintenance is dormant—last release was 2023-09-19 and no commits since 2023-09-22—but the package is marked Production/Stable and has received no security reports.
Requires Python 3.4 or higher and the sphinx-rtd-theme package to be installed and active in your Sphinx configuration.
License in practice
MIT license is permissive; you can use this in commercial or private projects without restriction, though you must retain the license notice.
Quickstart
pip install sphinx-rtd-dark-mode
# In conf.py:
extensions = ["sphinx_rtd_dark_mode"]
default_dark_mode = True # optional: users start in dark modeVerify before relying
- Whether the dark mode toggle works correctly with recent versions of sphinx-rtd-theme, given the last commit was 2023-09-22.
- Whether browser local storage persistence of user preference works across all modern browsers.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.4 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagesphinx-rtd-theme |
| Maintenance | Dormant 1,060 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 262,700 / month, #8,368 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableFramework :: Sphinx :: ExtensionLicense :: OSI Approved :: MIT LicenseNatural Language :: EnglishOperating System :: OS IndependentProgramming Language :: Python :: 3.5Programming Language :: Python :: 3.6Programming Language :: Python :: 3.7Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9 |
Evidence: sphinx_rtd_dark_mode-1.3.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx dark mode”
- sphinx-rtd-dark-modeAdds a toggleable dark mode interface to Sphinx documentation built…
- shibuyaShibuya is a Sphinx documentation theme that renders HTML…
- darkdetectDetects whether the operating system is in Dark Mode on macOS 10.14+,…
Give your agent the search over MCP, or paste the wish link into any chat.
More Sphinx packages
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured information like descriptions, parameters, return types, and exceptions.
Install it if you need to programmatically read and extract structured data from Python docstrings.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
A Sphinx extension that converts documentation source files into QtHelp format, enabling integration with Qt-based help systems and documentation viewers.
However, be aware that maintenance is dormant—if you rely on it long-term, monitor Sphinx compatibility and consider whether QtHelp remains the right format for your…
See also shibuya · sphinx-bootstrap-theme · sphinx-rtd-theme · darkdetect · sphinx-book-theme · sphinx-toggleprompt · Pallets-Sphinx-Themes · furo · sphinx-press-theme · sphinx-autobuild