readthedocs-sphinx-search
Advanced tools
Sphinx extension to enable search as you type for docs hosted on 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/
.. code-block:: bash
pip install readthedocs-sphinx-search
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
FAQs
Sphinx extension to enable search as you type for docs hosted on Read the Docs.
We found that readthedocs-sphinx-search demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
