readthedocs-sphinx-search

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

Project description

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

pip install readthedocs-sphinx-search

Add this extension in your conf.py file as:

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

This version

0.1.0rc3 pre-release

Sep 1, 2020

0.1.0rc2 pre-release

Aug 20, 2020

0.1.0rc1 pre-release

Jun 9, 2020

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

Files for readthedocs-sphinx-search, version 0.1.0rc3
Filename, size	File type	Python version	Upload date	Hashes
Filename, size readthedocs_sphinx_search-0.1.0rc3-py3-none-any.whl (25.8 kB)	File type Wheel	Python version py3	Upload date Sep 1, 2020	Hashes View
Filename, size readthedocs-sphinx-search-0.1.0rc3.tar.gz (20.9 kB)	File type Source	Python version None	Upload date Sep 1, 2020	Hashes View

Hashes for readthedocs_sphinx_search-0.1.0rc3-py3-none-any.whl
Algorithm	Hash digest
SHA256	`7911fcf906bdbbecae5fbdb415e084e53e03e0060a91df6708985cb40165d83c`
MD5	`8dc00beec337365f31012a6d751a8930`
BLAKE2-256	`c1bcab30462514700b06bb083ed5aac48a102b409148b1aad686d0d314f0e5e2`

Hashes for readthedocs-sphinx-search-0.1.0rc3.tar.gz
Algorithm	Hash digest
SHA256	`fe6e8384348f29f3d606646601a3dee570678611d59b94ad8d7cfd2e507329f4`
MD5	`1c4e93ed93f1295204a7acfa84bc0530`
BLAKE2-256	`1a2378ee468008c3ac4a3430a134c6fdcebb57165b6fad2cfb7f654e06d31af5`