Metadata-Version: 2.1
Name: readthedocs-sphinx-search
Version: 0.1.0rc1
Summary: Sphinx extension to enable search as you type for docs hosted on Read the Docs.
Home-page: https://github.com/readthedocs/readthedocs-sphinx-search
Author: Vaibhav Gupta
Author-email: vaibhgupt199@gmail.com
License: MIT
Project-URL: Documentation, https://readthedocs-sphinx-search.readthedocs.io/
Project-URL: Bug Reports, https://github.com/readthedocs/readthedocs-sphinx-search/issues
Project-URL: Source, https://github.com/readthedocs/readthedocs-sphinx-search
Description: readthedocs-sphinx-search
        =========================
        
        |pypi| |docs| |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.
        
        .. _Sphinx: https://www.sphinx-doc.org/
        .. _Read the Docs: https://readthedocs.org/
        
        Installation
        ------------
        
        ::
        
           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://travis-ci.org/readthedocs/readthedocs-sphinx-search.svg?branch=master
           :alt: Build Status
           :target: https://travis-ci.org/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
        
Keywords: sphinx search readthedocs
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Framework :: Sphinx :: Extension
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
