Instant search for Sphinx

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for rmcgibbo from gravatar.com rmcgibbo

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

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

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page