diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-05 16:20:59 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-05 16:20:59 +0000 |
commit | 5de84c9242643f786eff03726286578726d7d390 (patch) | |
tree | 8e8eadab2b786c41d7b8a2cdafbb467588928ad0 /doc/usage/advanced/websupport/quickstart.rst | |
parent | Releasing progress-linux version 7.2.6-8~progress7.99u1. (diff) | |
download | sphinx-5de84c9242643f786eff03726286578726d7d390.tar.xz sphinx-5de84c9242643f786eff03726286578726d7d390.zip |
Merging upstream version 7.3.7.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/usage/advanced/websupport/quickstart.rst')
-rw-r--r-- | doc/usage/advanced/websupport/quickstart.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/usage/advanced/websupport/quickstart.rst b/doc/usage/advanced/websupport/quickstart.rst index 1cdd23f..e7c2b51 100644 --- a/doc/usage/advanced/websupport/quickstart.rst +++ b/doc/usage/advanced/websupport/quickstart.rst @@ -137,7 +137,7 @@ add this data to the ``COMMENT_OPTIONS`` that are used in the template. This only works if your documentation is served from your document root. If it is served from another directory, you will - need to prefix the url route with that directory, and give the `docroot` + need to prefix the url route with that directory, and give the *docroot* keyword argument when creating the web support object:: support = WebSupport(..., docroot='docs') @@ -150,7 +150,7 @@ Performing Searches To use the search form built-in to the Sphinx sidebar, create a function to handle requests to the URL 'search' relative to the documentation root. The -user's search query will be in the GET parameters, with the key `q`. Then use +user's search query will be in the GET parameters, with the key ``q``. Then use the :meth:`~sphinxcontrib.websupport.WebSupport.get_search_results` method to retrieve search results. In `Flask <https://flask.palletsprojects.com/>`_ that would be like this:: |