Skip to main content

Sphinx Lumina Theme

PyPI version License Docs

A crisp, responsive Sphinx theme with readable typography, dark mode, and instant search. Self-hosted fonts, minimal setup, no external CDN calls.

Lumina installation guide with section navigation, code tabs, and a table of contents

Live demo & documentation · Configuration · Contributing

Features

  • Light and dark modes with a system-aware toggle.
  • Instant search with ⌘K / Ctrl+K access, optionally powered by Pagefind.
  • 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+. For Pagefind search, install sphinx-lumina-theme[pagefind].

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

Apache-2.0

Metadata

Release files for sphinx-lumina-theme 2.18.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-lumina-theme 2.18.0
File Size Uploaded Provenance Actions
sphinx_lumina_theme-2.18.0.tar.gz 1.9 MB With provenance Details for sphinx_lumina_theme-2.18.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-lumina-theme 2.18.0
File Interpreter ABI Platform Actions
sphinx_lumina_theme-2.18.0-py3-none-any.whl Python 3 none any Details for sphinx_lumina_theme-2.18.0-py3-none-any.whl

Total release size: 3.3 MB

Release files / sphinx_lumina_theme-2.18.0.tar.gz

Download URL sphinx_lumina_theme-2.18.0.tar.gz
Size 1.9 MB
Tags Source
SHA-256 checksum
How to use checksums
531ce3d0ed9c845e1fa25135c75c2daa5e3c2f356bbfbec8c649710d825c0c42
BLAKE2b-256 checksum
How to use checksums
342b461cfc38efe9ced0ce8548fba4d9391f771e927d8e4e6c63c4f338633a20
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 4, 2026.

Transparency log

Release files / sphinx_lumina_theme-2.18.0-py3-none-any.whl

Download URL sphinx_lumina_theme-2.18.0-py3-none-any.whl
Size 1.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
3cc48ed87f4edeffad24d135460746726413ac32331b169872c4c5b049149c23
BLAKE2b-256 checksum
How to use checksums
fa54268ddac2279c26f953d13600bde75324fd98a27c5c687bd35711e30b553d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 4, 2026.

Transparency log

Security for sphinx-lumina-theme 2.18.0

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for sphinx_lumina_theme-2.18.0.tar.gz

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 Nov 4, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.18.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page