Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/readthedocs/readthedocs-sphinx-search

Deprecated: Enable search-as-you-type feature for docs hosted by RTD.
https://github.com/readthedocs/readthedocs-sphinx-search

readthedocs search sphinx-extension

Last synced: 4 days ago
JSON representation

Deprecated: Enable search-as-you-type feature for docs hosted by RTD.

Host: GitHub
URL: https://github.com/readthedocs/readthedocs-sphinx-search
Owner: readthedocs
License: mit
Created: 2019-06-04T04:39:13.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-07-15T12:52:09.000Z (4 months ago)
Last Synced: 2024-08-27T18:12:06.396Z (3 months ago)
Topics: readthedocs, search, sphinx-extension
Language: Python
Homepage: https://readthedocs-sphinx-search.readthedocs.io/
Size: 1.92 MB
Stars: 34
Watchers: 8
Forks: 16
Open Issues: 22
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE

Awesome Lists containing this project

README

        readthedocs-sphinx-search - Search as you type for Read the Docs

================================================================

.. warning::

  **This extension is deprecated and it shouldn't be used.**

  Read more about this deprecation at https://github.com/readthedocs/readthedocs-sphinx-search/issues/144.

|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