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.0rc2.tar.gz (20.4 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.0rc2-py3-none-any.whl (25.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readthedocs-sphinx-search-0.1.0rc2.tar.gz
  • Upload date:
  • Size: 20.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.10

File hashes

Hashes for readthedocs-sphinx-search-0.1.0rc2.tar.gz
Algorithm Hash digest
SHA256 cbf2c4b015916609fdd2306a0931fb4c139801b582dd25bf215648cf35833a92
MD5 5d05d6adbd5266d167b6518a8a98240f
BLAKE2b-256 b426ccec116db6c7ef3675bbd5f3ec99928da070ef5aa2401a3c54f900504904

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readthedocs_sphinx_search-0.1.0rc2-py3-none-any.whl
  • Upload date:
  • Size: 25.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.10

File hashes

Hashes for readthedocs_sphinx_search-0.1.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 64d22520e7e49a4b19aaa85bbce1619b62c108207511a180a6471ed29e60793a
MD5 a63cf0a59dcf6fcf0283aa5487f5055e
BLAKE2b-256 157758720f0bc94860fa3ee367fdf207084f80c507511ce1646dcb1e46b203ea

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