Skip to content
New in 2.15: swap Lumina's fonts from your own CSS, and preview any of them live.
Lumina
User Documentation Installation, guides & reference Developer Documentation Architecture & development
  • Introduction
  • Getting Started
    • Installation
    • Configuration
  • Guides
    • Search
    • Dark Mode
    • MyST Markdown
    • Navigation
    • Custom Styling
    • Landing Page
    • Wide Layout
    • Icons
    • Development Workflow
    • SEO and discoverability
    • Internationalization
    • Read the Docs
  • Extensions
    • MyST Parser
    • sphinx-design
    • sphinx-copybutton
    • Mermaid Diagrams
    • OpenAPI
    • sphinx-llm
    • sphinx-js
    • sphinx-last-updated-by-git
    • MathJax
  • Reference
    • Typography
    • Admonitions
    • Code Blocks
    • Lists & Tables
    • Cards & Grids
    • Images & Figures
    • Badges & Buttons
    • Math
    • Diagrams
    • Footnotes & References
    • API Documentation
    • HTTP API Documentation
    • Icon Browser
    • CSS Variables
  • Releases
Built with Lumina v2.21.2
Lumina Index

Index

A | B | C | D | E | H | I | L | M | N | O | R | S | T | V

A

  • announcementBanner() (built-in function)

B

  • backToTop() (built-in function)
  • boot() (built-in function)
  • built-in function
    • connect()
    • legacy_connect()

C

  • connect()
    • built-in function
  • copyPage() (built-in function)
  • curlCopy() (built-in function)
  • curlCopyBtn() (built-in function)

D

  • DEFAULT_ACCENT_COLOR (in module sphinx_lumina_theme)
  • directive

E

  • emit() (EventEmitter method)
  • EventEmitter (built-in class)

H

  • handlers (EventEmitter attribute)
  • headerLinks() (built-in function)

I

  • initSearch() (built-in function)

L

  • :link: (directive option)
    • lumina-card (directive)
  • legacy_connect()
    • built-in function
  • lumina-card (directive)
    • :link: (directive option)
  • lumina-icon (role)
  • lumina::Cache (C++ class)
  • lumina::Cache::get (C++ function)
  • lumina_config (C struct)
  • LUMINA_MAX_DEPTH (C macro)
  • lumina_render (C function)

M

  • module
    • sphinx_lumina_theme
  • MyST

N

  • navDropdown() (built-in function)

O

  • off() (EventEmitter method)
  • on() (EventEmitter method)

R

  • role

S

  • scrollspy() (built-in function)
  • searchModal() (built-in function)
  • sidebar() (built-in function)
  • Sphinx
  • sphinx_lumina_theme
    • module
  • SUPPORTED_SEARCH_BACKENDS (in module sphinx_lumina_theme)

T

  • themeToggle() (built-in function)
  • ThemeToggle() (class)
  • tryIt() (built-in function)
  • tryItPanel() (built-in function)

V

  • versionSwitcher() (built-in function)
esc
↑↓ Navigate ↵ Open esc Close