Installation¶

Install the Lumina theme and build your first page.

1 min read

Prerequisites¶

You need a working Sphinx project. If you don’t have one yet:

uv (recommended)

mkdir my-docs && cd my-docs
uv init && uv add sphinx myst-parser
uv run sphinx-quickstart docs

pip

mkdir my-docs && cd my-docs
python -m venv .venv && source .venv/bin/activate
pip install sphinx myst-parser
sphinx-quickstart docs

Lumina requires Python 3.12+ and Sphinx 8.0+.

uv (recommended)

uv add sphinx-lumina-theme

pip

pip install sphinx-lumina-theme

Open your conf.py and set the theme:

conf.py¶

html_theme = "lumina"

That’s it — Lumina works with zero configuration. Build your docs:

uv (recommended)

uv run sphinx-build docs docs/_build/html

pip

sphinx-build docs docs/_build/html

Open docs/_build/html/index.html in your browser.

Tip

Press ⌘K / Ctrl+K to search your docs once Pagefind has indexed them. Search works after a full build — see Search for details.

You’ve got Lumina running. Next, tune it for your project or explore what it can do.

Configuration

Explore all theme options, accent colors, and the recommended setup.

Guides

Set up search, dark mode, MyST Markdown, navigation, and more.

Reference

Browse the complete reference for typography, admonitions, code blocks, and more.