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.
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.
Metadata
Release files for sphinx-searchlite 0.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx_searchlite-0.2.2.tar.gz | 18.1 kB | Without provenance | Details for sphinx_searchlite-0.2.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_searchlite-0.2.2-py3-none-any.whl | Python 3 | none | any | Details for sphinx_searchlite-0.2.2-py3-none-any.whl |
Total release size: 37.6 kB
Release files / sphinx_searchlite-0.2.2.tar.gz
| Download URL | sphinx_searchlite-0.2.2.tar.gz |
|---|---|
| Size | 18.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
29a6ef6278b9020899085ec70daf8f0d09e4d234c59631227915fbb173f64a30
|
|
BLAKE2b-256 checksum How to use checksums |
298aa0272410a8ca26e9cc2d4b0301e4d254aa2f5484aaa5fa5ad466b34719f9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / sphinx_searchlite-0.2.2-py3-none-any.whl
| Download URL | sphinx_searchlite-0.2.2-py3-none-any.whl |
|---|---|
| Size | 19.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eb4a63d8fdd9ccfca22f3bc892d77dc4baebb509ca0786a7caefb7fdb3f0d85f
|
|
BLAKE2b-256 checksum How to use checksums |
f8088e6816e5b67c87a0b9074a22b577d6bba82bf3f3d96b5b7700c78f868620
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Security for sphinx-searchlite 0.2.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.