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

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

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.1.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.1-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readthedocs-sphinx-search-0.1.1.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.4

File hashes

Hashes for readthedocs-sphinx-search-0.1.1.tar.gz
Algorithm Hash digest
SHA256 1f96e2875eee87aa4f1da1ad54adc55195ef1001db41f137aca9fb282aad3589
MD5 fbb13cf21c4725e2b030aaa6ea110012
BLAKE2b-256 ccef6f9a6a921e47e41771063ed059e587f2d224b69420e790c125c3aa545b27

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readthedocs_sphinx_search-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 19.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.4

File hashes

Hashes for readthedocs_sphinx_search-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7216c260244e2272e5577e7c37771f7fd34eeeda229bbeb5735b79e04c54a047
MD5 01f587686ac442eb1491775a2dbebe93
BLAKE2b-256 648ec3a883e929e1e72921b84409d90c57115b7e23e5f914d9ed128039cd1a67

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