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.2.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

readthedocs_sphinx_search-0.3.2-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for readthedocs-sphinx-search-0.3.2.tar.gz
Algorithm Hash digest
SHA256 277773bfa28566a86694c08e568d5a648cd80f22826545555a764d6d20c365fb
MD5 dc55eff42be512e657dffd66d3615f8a
BLAKE2b-256 8f960c51439e3dbc634cf5328ffb173ff759b7fc9abf3276e78bf71d9fc0aa51

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for readthedocs_sphinx_search-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 58716fd21f01581e6e67bf3bc02e79c77e10dc58b5f8e4c7cc1977e013eda173
MD5 ab6c0a85a3ca30e6fb317d51c05cfc83
BLAKE2b-256 043c41bc9d7d4d936a73e380423f23996bee1691e17598d8a03c062be6aac640

See more details on using hashes here.

Supported by

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