sphinx-searchlite

Client-side documentation search for any Sphinx theme. It needs no search service, no runtime dependency, and no build step beyond Sphinx itself.

Build Status codecov License PyPI

Quick start

Install the package:

pip install sphinx-searchlite

Add it to conf.py:

extensions = ["sphinx_searchlite"]

Build your docs and open any page. Press / or ⌘K (Ctrl+K on Linux and Windows) to open the search dialog. If your theme has its own search box, clicking it opens the same dialog.

Documentation

  • How-to guides: keep the theme’s search box, write your own UI, add triggers, and restyle the dialog.

  • Reference: configuration options, the JavaScript API, the index format, and CSS custom properties.

  • Explanation: why searchlite exists, how ranking works, and how the dialog picks its colors.

Note

This library was generated using copier from the Base Python Project Template repository.