Skip to main content

Instant search for Sphinx

Project description

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

http://i.giphy.com/3o85xmqkbt14LuRcZO.gif

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-lunrsearch, version 0.3
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_lunrsearch-0.3-py2.py3-none-any.whl (9.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size sphinxcontrib-lunrsearch-0.3.tar.gz (8.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page