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.1.2.tar.gz (15.6 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.1.2-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for readthedocs-sphinx-search-0.1.2.tar.gz
Algorithm Hash digest
SHA256 66d950fadcc044a082816763c766d3ebc7130cb84caeabbffa239368dc5124fe
MD5 0e09c1971855ff9ac5ee6d4c7e5fe12f
BLAKE2b-256 d0c1e0c85f0795b6a09a58c63be40a756f040993e63fa914285112f5402da996

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for readthedocs_sphinx_search-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f3eacbebf766c0b12342462959913d4c5b2de1763f790a46563f719cd910f0f7
MD5 0f2c87aca76c025aa42a75e6982cf30a
BLAKE2b-256 e568103204e6c10388bd8a82dde70b422642f4fcc147fbec921f192e1df3babc

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