Skip to content
Enable search-as-you-type feature for docs hosted by RTD.
Python JavaScript CSS Shell
Branch: master
Clone or download
ericholscher Merge pull request #43 from readthedocs/remove-highlight-url-param
Remove 'highlight' URL param from search results
Latest commit a40e97f Aug 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs use & Jul 20, 2019
scripts
sphinx_search remove highlight url param Aug 21, 2019
tests update tests Jul 20, 2019
.gitattributes Add demo gif Jun 10, 2019
.gitignore update gitignore Jun 20, 2019
.readthedocs.yml Update .readthedocs.yml file to formats: [] Jul 22, 2019
.travis.yml add jsdoc in travis Jul 17, 2019
LICENSE basic setup Jun 4, 2019
MANIFEST.in rename _static to static everywhere Jul 17, 2019
README.rst change rtfd to readthedocs everywhere Jun 30, 2019
gulpfile.js
package.json use gulp to automate Jun 4, 2019
pytest.ini use sphinx 18 syntax Jul 8, 2019
setup.py change rtfd to readthedocs everywhere Jun 30, 2019
tox.ini revert changes Jul 20, 2019

README.rst

readthedocs-sphinx-search

Documentation Status Repository license Build Status

Sphinx extension to enable search as you type feature for docs hosted by Read the Docs.

Installation

pip install git+https://github.com/readthedocs/readthedocs-sphinx-search@master

Configuration

Add this extension in your conf.py file as:

extensions = [
 # ... other extensions here
 'sphinx_search.extension',
]

Documentation

Check out the full documentation at https://readthedocs-sphinx-search.readthedocs.io/

You can’t perform that action at this time.