readthedocs-sphinx-search - Search as you type for Read the Docs
================================================================
|pypi| |docs| |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.
.. _Sphinx: https://www.sphinx-doc.org/
.. _Read the Docs: https://readthedocs.org/
Installation
------------
.. code-block:: bash
pip install readthedocs-sphinx-search
Configuration
-------------
Add this extension in your ``conf.py`` file as:
.. code-block:: python
extensions = [
# ... other extensions here
'sphinx_search.extension',
]
.. |docs| image:: https://readthedocs.org/projects/readthedocs-sphinx-search/badge/?version=latest
:alt: Documentation Status
:target: https://readthedocs-sphinx-search.readthedocs.io/en/latest/?badge=latest
.. |license| image:: https://img.shields.io/github/license/readthedocs/readthedocs-sphinx-search.svg
:target: LICENSE
:alt: Repository license
.. |build-status| image:: https://circleci.com/gh/readthedocs/readthedocs-sphinx-search.svg?style=svg
:alt: Build status
:target: https://circleci.com/gh/readthedocs/readthedocs-sphinx-search
.. |pypi| image:: https://img.shields.io/pypi/v/readthedocs-sphinx-search.svg
:target: https://pypi.python.org/pypi/readthedocs-sphinx-search
:alt: PyPI Version
Raw data
{
"_id": null,
"home_page": "https://github.com/readthedocs/readthedocs-sphinx-search",
"name": "readthedocs-sphinx-search",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "sphinx search readthedocs",
"author": "Vaibhav Gupta",
"author_email": "vaibhgupt199@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8f/96/0c51439e3dbc634cf5328ffb173ff759b7fc9abf3276e78bf71d9fc0aa51/readthedocs-sphinx-search-0.3.2.tar.gz",
"platform": null,
"description": "readthedocs-sphinx-search - Search as you type for Read the Docs\n================================================================\n\n|pypi| |docs| |license| |build-status|\n\n``readthedocs-sphinx-search`` is a `Sphinx`_ extension to enable *search as you type* for docs hosted on `Read the Docs`_.\nTry it at https://readthedocs-sphinx-search.readthedocs.io/en/latest/?rtd_search=testing.\n\n.. _Sphinx: https://www.sphinx-doc.org/\n.. _Read the Docs: https://readthedocs.org/\n\nInstallation\n------------\n\n.. code-block:: bash\n\n pip install readthedocs-sphinx-search\n\n\nConfiguration\n-------------\n\nAdd this extension in your ``conf.py`` file as:\n\n.. code-block:: python\n\n extensions = [\n # ... other extensions here\n 'sphinx_search.extension',\n ]\n\n\n.. |docs| image:: https://readthedocs.org/projects/readthedocs-sphinx-search/badge/?version=latest\n :alt: Documentation Status\n :target: https://readthedocs-sphinx-search.readthedocs.io/en/latest/?badge=latest\n\n.. |license| image:: https://img.shields.io/github/license/readthedocs/readthedocs-sphinx-search.svg\n :target: LICENSE\n :alt: Repository license\n\n.. |build-status| image:: https://circleci.com/gh/readthedocs/readthedocs-sphinx-search.svg?style=svg\n :alt: Build status\n :target: https://circleci.com/gh/readthedocs/readthedocs-sphinx-search\n\n\n.. |pypi| image:: https://img.shields.io/pypi/v/readthedocs-sphinx-search.svg\n :target: https://pypi.python.org/pypi/readthedocs-sphinx-search\n :alt: PyPI Version\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Sphinx extension to enable search as you type for docs hosted on Read the Docs.",
"version": "0.3.2",
"project_urls": {
"Bug Reports": "https://github.com/readthedocs/readthedocs-sphinx-search/issues",
"Documentation": "https://readthedocs-sphinx-search.readthedocs.io/",
"Homepage": "https://github.com/readthedocs/readthedocs-sphinx-search",
"Source": "https://github.com/readthedocs/readthedocs-sphinx-search"
},
"split_keywords": [
"sphinx",
"search",
"readthedocs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "043c41bc9d7d4d936a73e380423f23996bee1691e17598d8a03c062be6aac640",
"md5": "ab6c0a85a3ca30e6fb317d51c05cfc83",
"sha256": "58716fd21f01581e6e67bf3bc02e79c77e10dc58b5f8e4c7cc1977e013eda173"
},
"downloads": -1,
"filename": "readthedocs_sphinx_search-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ab6c0a85a3ca30e6fb317d51c05cfc83",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 21379,
"upload_time": "2024-01-15T16:46:20",
"upload_time_iso_8601": "2024-01-15T16:46:20.552054Z",
"url": "https://files.pythonhosted.org/packages/04/3c/41bc9d7d4d936a73e380423f23996bee1691e17598d8a03c062be6aac640/readthedocs_sphinx_search-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f960c51439e3dbc634cf5328ffb173ff759b7fc9abf3276e78bf71d9fc0aa51",
"md5": "dc55eff42be512e657dffd66d3615f8a",
"sha256": "277773bfa28566a86694c08e568d5a648cd80f22826545555a764d6d20c365fb"
},
"downloads": -1,
"filename": "readthedocs-sphinx-search-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "dc55eff42be512e657dffd66d3615f8a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 21949,
"upload_time": "2024-01-15T16:46:22",
"upload_time_iso_8601": "2024-01-15T16:46:22.565128Z",
"url": "https://files.pythonhosted.org/packages/8f/96/0c51439e3dbc634cf5328ffb173ff759b7fc9abf3276e78bf71d9fc0aa51/readthedocs-sphinx-search-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-15 16:46:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "readthedocs",
"github_project": "readthedocs-sphinx-search",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "readthedocs-sphinx-search"
}
JSON
