readthedocs-sphinx-search

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


Keywords
sphinx, search, readthedocs, sphinx-extension
License
MIT
Install
pip install readthedocs-sphinx-search==0.3.2

Documentation

readthedocs-sphinx-search - Search as you type for Read the Docs

Warning

This extension is deprecated and it shouldn't be used. Read more about this deprecation at #144.

PyPI Version Documentation Status Repository license Build status

readthedocs-sphinx-search is a Sphinx extension to enable search as you type for docs hosted on Read the Docs. Try it at https://readthedocs-sphinx-search.readthedocs.io/en/latest/?rtd_search=testing.

Installation

pip install readthedocs-sphinx-search

Configuration

Add this extension in your conf.py file as:

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