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.

Source Distribution

sphinxcontrib-lunrsearch-0.4.tar.gz (9.4 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page