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.2.0.tar.gz (15.2 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.2.0-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for readthedocs-sphinx-search-0.2.0.tar.gz
Algorithm Hash digest
SHA256 fb7eda7e1493fdbd77dd5f3951286a68bfa3cf3bb17dd73ecaf4214ffb0d26e6
MD5 af1c79d40d5569033cf6ec1f33652d89
BLAKE2b-256 0790c8e49c4b9f61b17e8edd24f8b2addc8776c1b076a6cbbe2adeb7e5d5a7a2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for readthedocs_sphinx_search-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5fbfbd6587cffde92829d3571d888f86d2fa9ae71d26c1e28e1c0ae2a7d6a2bc
MD5 ebfa8c34230659b11a7fef574d99d951
BLAKE2b-256 89682ca8e06cd2a7ee06a19874ca166fb640e0d158bf081414564f1573492afd

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