Skip to content

evennia/sphinxcontrib-lunrsearch

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sphinxcontrib-lunrsearch

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

Packages

No packages published

Languages

  • Python 34.0%
  • CSS 30.7%
  • JavaScript 28.7%
  • HTML 6.6%