Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stsewd committed Aug 18, 2021
1 parent 90a113d commit 37d17d5
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,22 @@ available at :doc:`Testing page <testing>`.
Local testing
-------------

This extension works when is hosted on Read the Docs,
to make it work locally a custom ``READTHEDOCS_DATA`` js variable is injected automatically
to send the search requests to https://readthedocs.org/api/v2/search/.
You can test this extension from the docs folder:

.. prompt:: bash

cd docs
pip install sphinx-autobuild
pip install -r requirement.txt
sphinx-autobuild . _build/html

Go to http://127.0.0.1:8000 and start searching!

.. note::

The extension works when is hosted on Read the Docs,
but to make it work locally a custom ``READTHEDOCS_DATA`` js variable is injected automatically
to send the search requests to https://readthedocs.org/api/v2/search/.

Releasing
---------
Expand Down

0 comments on commit 37d17d5

Please sign in to comment.