Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

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

Project details


Release history Release notifications

This version
History Node

0.3

History Node

0.2

History Node

0.1.1

History Node

0.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxcontrib_lunrsearch-0.3-py2.py3-none-any.whl (9.1 kB) Copy SHA256 hash SHA256 Wheel py2.py3 May 3, 2018
sphinxcontrib-lunrsearch-0.3.tar.gz (8.3 kB) Copy SHA256 hash SHA256 Source None May 3, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page