This extension modifies the search box in Sphinx documentation to show instant results as you type. It’s particularly suited for searching through APIs.
To get started, $ pip install sphinxcontrib-lunrsearch and then add 'sphinxcontrib.lunrsearch' to the list of extensions in your Sphinx conf.py file.
Options
The following options can be set in conf.py:
lunrsearch_highlight: bool
Whether to highlight the seach term after navigating to a results. The default is False.
Example
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-lunrsearch 0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxcontrib-lunrsearch-0.4.tar.gz | 9.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_lunrsearch-0.4-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 18.0 kB
Release files / sphinxcontrib-lunrsearch-0.4.tar.gz
| Download URL | sphinxcontrib-lunrsearch-0.4.tar.gz |
|---|---|
| Size | 9.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2c0c572c0fdf0c5d24400b43ff1d886cac9ceb21b0ff29e753c3b9f4f2c90c02
|
|
BLAKE2b-256 checksum How to use checksums |
d4e6e7f4a423eeb4eb2dffc926f282ca244b66a58b51629d7a2c1e0e9da079de
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1.post20210325 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.8
|
Release files / sphinxcontrib_lunrsearch-0.4-py2.py3-none-any.whl
| Download URL | sphinxcontrib_lunrsearch-0.4-py2.py3-none-any.whl |
|---|---|
| Size | 8.6 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
c8ed5f5bb106589b123a3ff7458e32404c5b10978578c64f759a02a7040fceb7
|
|
BLAKE2b-256 checksum How to use checksums |
33ab0da92aa00c2d16fa88884e9888f872da1f12d73d9506f883a0a9c2f15d11
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1.post20210325 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.8
|
