Skip to main content

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

Project description

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

Project details


Download files

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

Source Distribution

readthedocs-sphinx-search-0.3.0.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

readthedocs_sphinx_search-0.3.0-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file readthedocs-sphinx-search-0.3.0.tar.gz.

File metadata

File hashes

Hashes for readthedocs-sphinx-search-0.3.0.tar.gz
Algorithm Hash digest
SHA256 3c733d0483f3823036fd597fa845ba22dcbc409d485aeb79c42fffc81c741f3f
MD5 e9f53e3eadb11b7a6216bc2ae34b47a9
BLAKE2b-256 7820e3cc7507a4a40c877a203a17c4daadb8a463d6c09d28e2705f903b1f88a4

See more details on using hashes here.

File details

Details for the file readthedocs_sphinx_search-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for readthedocs_sphinx_search-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d50a7f7e5932699c297534cc49e028e9d2a9cf53b5853ec8091d504ec41496a7
MD5 cd272256d3ebeb9402d14a792926af94
BLAKE2b-256 53197c00a6383c48995f5c63c1f430b670579e246ac4e90a39305a8f52622404

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page