Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

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

Release History

Release History

This version
History Node

0.2

History Node

0.1.1

History Node

0.1

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinxcontrib_lunrsearch-0.2-py2.py3-none-any.whl (9.0 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Dec 14, 2015
sphinxcontrib-lunrsearch-0.2.tar.gz (7.5 kB) Copy SHA256 Checksum SHA256 Source Dec 14, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting