GitHub - readthedocs/readthedocs-sphinx-search: Deprecated: Enable search-as-you-type feature for docs hosted by RTD.

2 min read Original article ↗

Skip to content

Navigation Menu

Sign in

Appearance settings

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up

Appearance settings

This repository was archived by the owner on Apr 8, 2025. It is now read-only.

Deprecated: Enable search-as-you-type feature for docs hosted by RTD.

License

MIT license

36 stars 12 forks Branches Tags Activity

Notifications You must be signed in to change notification settings

Repository files navigation

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',
]