diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-05 16:20:58 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-05 16:20:58 +0000 |
commit | 5bb0bb4be543fd5eca41673696a62ed80d493591 (patch) | |
tree | ad2c464f140e86c7f178a6276d7ea4a93e3e6c92 /doc/usage/advanced/websupport | |
parent | Adding upstream version 7.2.6. (diff) | |
download | sphinx-5bb0bb4be543fd5eca41673696a62ed80d493591.tar.xz sphinx-5bb0bb4be543fd5eca41673696a62ed80d493591.zip |
Adding upstream version 7.3.7.upstream/7.3.7
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/usage/advanced/websupport')
-rw-r--r-- | doc/usage/advanced/websupport/quickstart.rst | 4 | ||||
-rw-r--r-- | doc/usage/advanced/websupport/searchadapters.rst | 2 | ||||
-rw-r--r-- | doc/usage/advanced/websupport/storagebackends.rst | 2 |
3 files changed, 4 insertions, 4 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:: diff --git a/doc/usage/advanced/websupport/searchadapters.rst b/doc/usage/advanced/websupport/searchadapters.rst index 262d666..ad7a11c 100644 --- a/doc/usage/advanced/websupport/searchadapters.rst +++ b/doc/usage/advanced/websupport/searchadapters.rst @@ -7,7 +7,7 @@ Search Adapters To create a custom search adapter you will need to subclass the :class:`BaseSearch` class. Then create an instance of the new class and pass -that as the `search` keyword argument when you create the :class:`~.WebSupport` +that as the *search* keyword argument when you create the :class:`~.WebSupport` object:: support = WebSupport(srcdir=srcdir, diff --git a/doc/usage/advanced/websupport/storagebackends.rst b/doc/usage/advanced/websupport/storagebackends.rst index ccb00b6..c50edf8 100644 --- a/doc/usage/advanced/websupport/storagebackends.rst +++ b/doc/usage/advanced/websupport/storagebackends.rst @@ -7,7 +7,7 @@ Storage Backends To create a custom storage backend you will need to subclass the :class:`StorageBackend` class. Then create an instance of the new class and -pass that as the `storage` keyword argument when you create the +pass that as the *storage* keyword argument when you create the :class:`~.WebSupport` object:: support = WebSupport(srcdir=srcdir, |