Copy as Markdown Edit this page

On this page

Extensions

Lumina is designed to work with extensions that target standard Sphinx output. These are the ones we recommend and style specifically.

1 min read

MyST Parser recommended

Write documentation in Markdown with full Sphinx directive support.

MyST Parser

sphinx-design recommended

Cards, grids, tabs, badges, buttons, and dropdowns.

sphinx-design

sphinx-copybutton recommended

Copy-to-clipboard button on every code block.

sphinx-copybutton

Mermaid optional

Flowcharts, sequence diagrams, class diagrams, and more.

Mermaid Diagrams

OpenAPI optional

Auto-generated HTTP API docs from OpenAPI specs.

OpenAPI

sphinx-js optional

Auto-generated JavaScript API docs from JSDoc comments.

sphinx-js

sphinx-llm optional

LLM-friendly docs following the llms.txt convention.

sphinx-llm

sphinx-last-updated-by-git optional

Show “Last updated” dates in the page footer from git history.

sphinx-last-updated-by-git

MathJax built-in

LaTeX math rendering with MathJax.

MathJax

Other Compatible Extensions

Lumina inherits from Sphinx’s basic theme, so it works with any extension that targets standard Sphinx output:

Extension	Purpose
sphinx.ext.autodoc	Generate API docs from Python docstrings.
sphinx.ext.intersphinx	Cross-reference objects in other Sphinx projects.
sphinx.ext.viewcode	Add links to highlighted source code.
sphinx.ext.napoleon	Support for Google and NumPy docstring styles.
sphinx.ext.todo	Collect and display TODO items.
sphinx_autodoc_typehints	Render type hints in API documentation.

Recommended conf.py

A well-rounded configuration that includes all the recommended extensions:

conf.py — Recommended extensions setup

extensions = [
    # Content
    "myst_parser",
    "sphinx_design",
    "sphinx_copybutton",
    "sphinxcontrib.mermaid",
    "sphinxcontrib.openapi",

    # LLM-friendly output
    "sphinx_llm.txt",

    # API documentation (if applicable)
    "sphinx_js",                    # JS API from JSDoc
    "sphinx.ext.autodoc",
    "sphinx.ext.intersphinx",
    "sphinx.ext.napoleon",
    "sphinx.ext.viewcode",
]

# MyST configuration
myst_enable_extensions = [
    "colon_fence",
    "dollarmath",
    "amsmath",
    "tasklist",
    "deflist",
    "fieldlist",
    "substitution",
]

# Copy button: strip shell prompts
copybutton_prompt_text = r">>> |\.\.\. |\$ |> "
copybutton_prompt_is_regexp = True

# Intersphinx: link to Python and Sphinx docs
intersphinx_mapping = {
    "python": ("https://docs.python.org/3", None),
    "sphinx": ("https://www.sphinx-doc.org/en/master", None),
}