Skip to content

Commit 624b13d

Browse files
authored
Search: API V3 (#9625)
* Convert api.py to module api/v2 * Black * Fix tests * Search: refactor serializer's context We were generating the context of the serializer from outside, but we can do this from the serializer itself, this way we don't have to duplicate this logic. * Search API V3 * Support new syntax in the dashboard * Black * Redirect to global search from project search * Black * Refactor * Move server-side-search docs * Add docs * Fixes * Update links * Fixes * Fix tests * Tests * Linter * Format * This shouldn't be here * Fix import * Fix tests * Black * Fix test * Updates from review * Inherit from API v3 settings * Add a note about using yield * Rename Backend -> SearchExecutor * More renaming * Don't depend on the order * We can't use dicts in a set :( * False alarm, we just needed to set the version public * Set privacy level explicitly * Override global rate limit * Comment
1 parent c2849d3 commit 624b13d

33 files changed

+2069
-633
lines changed

docs/user/analytics.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ and then click on :guilabel:`Traffic Analytics`.
1616

1717
Traffic analytics demo
1818

19-
You can also access to analytics data from :ref:`search results <server-side-search:Search Analytics>`.
19+
You can also access to analytics data from :ref:`search results <server-side-search/index:Search Analytics>`.
2020

2121
.. note::
2222

docs/user/api/v3.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1882,4 +1882,4 @@ Embed
18821882
Additional APIs
18831883
---------------
18841884

1885-
- :ref:`Server side search API <server-side-search:api>`.
1885+
- :doc:`Server side search API </server-side-search/api>`.

docs/user/build-customization.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ Read the Docs will automatically index the content of all your HTML files,
408408
respecting the :ref:`search <config-file/v2:search>` options from your config file.
409409

410410
You can access the search results from the :guilabel:`Search` tab of your project,
411-
or by using the :ref:`search API <server-side-search:api>`.
411+
or by using the :doc:`/server-side-search/api`.
412412

413413
.. note::
414414

docs/user/config-file/v2.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -684,7 +684,7 @@ Do a recursive clone of the submodules.
684684
search
685685
~~~~~~
686686

687-
Settings for more control over :doc:`/server-side-search`.
687+
Settings for more control over :doc:`/server-side-search/index`.
688688

689689
.. code-block:: yaml
690690

docs/user/features.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,10 @@ We offer a number of search features:
7070

7171
* Search across :doc:`subprojects </subprojects>`
7272
* Search results land on the exact content you were looking for
73-
* Search across projects you have access to (available on |com_brand|)
74-
* A full range of :doc:`search operators </guides/advanced-search>` including exact matching and excluding phrases.
73+
* Search across projects you have access to
74+
* A full range of :doc:`search operators </server-side-search/syntax>` including exact matching and excluding phrases.
7575

76-
Learn more about :doc:`/server-side-search`.
76+
Learn more about :doc:`/server-side-search/index`.
7777

7878
Open Source and Customer Focused
7979
--------------------------------

docs/user/flyout-menu.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The flyout menu provides access to the following bits of Read the Docs functiona
1515
* :doc:`Downloadable formats </downloadable-documentation>` for the current version, including HTML & PDF downloads that are enabled by the project.
1616
* Links to the Read the Docs dashboard for the project.
1717
* Links to your :doc:`VCS provider </integrations>` that allow the user to quickly find the exact file that the documentation was rendered from.
18-
* A search bar that gives users access to our :doc:`/server-side-search` of the current version.
18+
* A search bar that gives users access to our :doc:`/server-side-search/index` of the current version.
1919

2020
Closed
2121
~~~~~~

docs/user/guides/administrators.rst

-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ have a look at our :doc:`/tutorial/index`.
1414

1515
technical-docs-seo-guide
1616
manage-translations-sphinx
17-
advanced-search
1817
hiding-a-version
1918
deprecating-content
2019
pdf-non-ascii-languages

docs/user/guides/advanced-search.rst

-97
This file was deleted.

docs/user/index.rst

+2-3
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ and some of the core features of Read the Docs.
7878
:doc:`/versions` |
7979
:doc:`/downloadable-documentation` |
8080
:doc:`/hosting` |
81-
:doc:`/server-side-search` |
81+
:doc:`/server-side-search/index` |
8282
:doc:`/analytics` |
8383
:doc:`/pull-requests` |
8484
:doc:`/build-notifications` |
@@ -111,7 +111,7 @@ and some of the core features of Read the Docs.
111111
/versions
112112
/downloadable-documentation
113113
/hosting
114-
/server-side-search
114+
/server-side-search/index
115115
/analytics
116116
/pull-requests
117117
/build-notifications
@@ -145,7 +145,6 @@ and how to write successful documentation.
145145
* **For project administrators**:
146146
:doc:`/guides/technical-docs-seo-guide` |
147147
:doc:`/guides/manage-translations-sphinx` |
148-
:doc:`/guides/advanced-search` |
149148
:doc:`/guides/private-submodules` |
150149
Setup Build Notifications <build-notifications> |
151150
:doc:`More guides for administrators </guides/administrators>`

docs/user/server-side-search.rst

-202
This file was deleted.

0 commit comments

Comments
 (0)