Sphinx Lumina Theme
A crisp, responsive Sphinx theme with readable typography, dark mode, and instant search. Self-hosted fonts, minimal setup, no external CDN calls.
Live demo & documentation · Configuration · Contributing
Features
- Light and dark modes with a system-aware toggle.
- Instant search powered by Pagefind, with
⌘K/Ctrl+Kaccess. - Responsive navigation with section and version switchers, a collapsible sidebar, and a mobile page outline.
- Rich content with MyST Markdown, syntax highlighting, and one-click code copying.
- Interactive API docs with OpenAPI support, request panels, and curl copying.
- Customizable branding through
conf.py: colors, logos, navigation, and social links.
Quick Start
Requires Python 3.12+ and Sphinx 8.0+. Pagefind search also needs Node.js so the build can create its search index.
pip install sphinx-lumina-theme
Using uv? Run uv add sphinx-lumina-theme instead.
Set the theme in your conf.py:
html_theme = "lumina"
Build your docs:
sphinx-build docs docs/_build/html
With uv, prefix the build command with uv run. Open docs/_build/html/index.html to view the result.
New to Sphinx? Start with the installation guide, including project creation and MyST setup.
Upgrading from 1.x? Review the Lumina 2 migration notes if you use custom CSS or templates.
Contributing
See the contributing guide for local setup, asset builds, and tests. Bug reports and pull requests are welcome.
License
1 maintainer
Release files for sphinx-lumina-theme 2.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_lumina_theme-2.1.0.tar.gz | 1.5 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_lumina_theme-2.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.6 MB
Release files / sphinx_lumina_theme-2.1.0.tar.gz
| Download URL | sphinx_lumina_theme-2.1.0.tar.gz |
|---|---|
| Size | 1.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c7d84f1ba417240718ed914d43d756893d6aabffaf279e6683e1da31c0a7f6d3
|
|
BLAKE2b-256 checksum How to use checksums |
4bd04edb1678e62c7e63bd47e5f131ba37e4795eddc99a7266505002a99c1181
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 20, 2026.
Transparency logRelease files / sphinx_lumina_theme-2.1.0-py3-none-any.whl
| Download URL | sphinx_lumina_theme-2.1.0-py3-none-any.whl |
|---|---|
| Size | 1.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6a16822983eef1aacbf69872484486bc8a912244653daeacddd96e6c0b00512e
|
|
BLAKE2b-256 checksum How to use checksums |
554a850af81c5561d784b21a380a266f82fe3f23f2c723deb8282ef3e88eb7ae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 20, 2026.
Transparency log
