sphinx-fuma

A responsive Sphinx theme inspired by Fumadocs.

Features

• Responsive documentation and notebook layouts
• Collapsible page navigation, breadcrumbs, pagination, page icons, and section tabs
• Scroll-aware page table of contents
• Client-side search powered by sphinx-searchlite
• Light and dark modes, color presets, and CSS variable overrides
• Self-hosted Geist and JetBrains Mono fonts, with a system-font option
• Native steps and files directives
• Styling for standard Sphinx content and Sphinx Design cards and tabs

Quick start

Install the theme:

pip install sphinx-fuma

Enable the extension and theme in conf.py:

extensions = ["sphinx_fuma"]
html_theme = "fuma"

Build the documentation as usual:

sphinx-build -M html docs docs/_build

Documentation

• How to configure sphinx-fuma
• Theme option reference
• Content component showcase

The published documentation is built with sphinx-fuma and demonstrates its navigation, search, color, and content features.

[!NOTE] This library was generated using copier from the Base Python Project Template repository.