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.0.tar.gz (21.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.1.0-py3-none-any.whl (26.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readthedocs-sphinx-search-0.1.0.tar.gz
  • Upload date:
  • Size: 21.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.9.1

File hashes

Hashes for readthedocs-sphinx-search-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5c0a90068c9c0ca639aa3a1c14a7fe8587b0332f2349bc3fd86b968ca82db238
MD5 4bbd6c5410e8e9cf8f5c037c8c8811d5
BLAKE2b-256 b71f0ae00451b10084bf6c2dfd53e83a8143e941260f09e2694dae5efde0db46

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readthedocs_sphinx_search-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 26.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.9.1

File hashes

Hashes for readthedocs_sphinx_search-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7ed45d83b11af9681d5439529c7fbd4289c5be3f9ac4688436e28cb669da87a2
MD5 fb23433b4eb5e277320cc731a13cc325
BLAKE2b-256 0b5c159d1c7ae251e958208f4e44db41a4a0dba1cf53bcafb55638485e341493

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