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.
Installation
pip install readthedocs-sphinx-search
Configuration
Add this extension in your conf.py file as:
extensions = [
# ... other extensions here
'sphinx_search.extension',
]Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file readthedocs-sphinx-search-0.1.0rc1.tar.gz.
File metadata
- Download URL: readthedocs-sphinx-search-0.1.0rc1.tar.gz
- Upload date:
- Size: 20.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5620f4203ec739ef08c0577356bf091c8a301f01d29a0c02bf69e0deca2a76e8 |
|
| MD5 | c3c2d6d5b6095a7f30d7980848fc5f37 |
|
| BLAKE2b-256 | d7332215a408f49decb19d2cfdb272bc3b3868d42b55a8dfc9b9b11558996c18 |
Provenance
File details
Details for the file readthedocs_sphinx_search-0.1.0rc1-py3-none-any.whl.
File metadata
- Download URL: readthedocs_sphinx_search-0.1.0rc1-py3-none-any.whl
- Upload date:
- Size: 26.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | aa3c8f471c49468806d70033ec4b0df5fc1985fdd6a34543685b35786c65ce07 |
|
| MD5 | 00ded908dcaae97d8f8e68df2230b6c3 |
|
| BLAKE2b-256 | 096f3f78a3429c69045cf1191476e49db614aac14933cc70e3fe8d7604e7991c |
