From 3ad269c6c14c8a8d702bfc9e42f6dc1fec95d11d Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Fri, 13 Jan 2023 23:40:04 +0100 Subject: [PATCH 1/3] Relabel Server Side Search pages as Explanation and Reference, add seealso:: box --- docs/user/index.rst | 8 +++++--- docs/user/server-side-search/index.rst | 17 ++++++----------- 2 files changed, 11 insertions(+), 14 deletions(-) diff --git a/docs/user/index.rst b/docs/user/index.rst index 2e72c8b884c..489874f78ec 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -87,6 +87,7 @@ to help you create fantastic documentation for your project. /single_version /science /commercial/organizations + /server-side-search/index .. toctree:: :maxdepth: 2 @@ -106,8 +107,10 @@ to help you create fantastic documentation for your project. :caption: Reference :glob: - api/index - reference/features + /api/index + /server-side-search/api + /reference/features + /server-side-search/syntax Read the Docs feature overview @@ -153,7 +156,6 @@ and some of the core features of Read the Docs. /integrations /versions /hosting - /server-side-search/index /security-log /builds diff --git a/docs/user/server-side-search/index.rst b/docs/user/server-side-search/index.rst index daff3022967..84aad36bf31 100644 --- a/docs/user/server-side-search/index.rst +++ b/docs/user/server-side-search/index.rst @@ -6,22 +6,17 @@ this is powered by Elasticsearch_. You can search all projects at https://readthedocs.org/search/, or search only on your project from the :guilabel:`Search` tab of your project. -.. contents:: Table of contents - :local: - :backlinks: none - :depth: 3 +.. seealso:: -.. toctree:: - :maxdepth: 2 - :glob: - :hidden: - - * + :doc:`/server-side-search/syntax` + Syntax options for searching Read the Docs projects + :doc:`/server-side-search/api` + Reference to the Server Side Search API Search features --------------- -We offer a number of benefits compared to other documentation hosts: +Read the Docs has the following search features: Search across :doc:`subprojects ` Subprojects allow you to host multiple discrete projects on a single domain. From dbf54d03d3524184000e3c8dcde7f0d825fed4b6 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Fri, 13 Jan 2023 23:43:11 +0100 Subject: [PATCH 2/3] Reference back to explanation from Syntax reference, remove a TOC that isn't conventional --- docs/user/server-side-search/api.rst | 5 ----- docs/user/server-side-search/syntax.rst | 11 +++-------- 2 files changed, 3 insertions(+), 13 deletions(-) diff --git a/docs/user/server-side-search/api.rst b/docs/user/server-side-search/api.rst index f954c0c781b..c473da80f9c 100644 --- a/docs/user/server-side-search/api.rst +++ b/docs/user/server-side-search/api.rst @@ -7,11 +7,6 @@ If you are using :doc:`/commercial/index` you will need to replace https://readthedocs.org/ with https://readthedocs.com/ in all the URLs used in the following examples. Check :ref:`server-side-search/api:authentication and authorization` if you are using private versions. -.. contents:: Table of contents - :local: - :backlinks: none - :depth: 3 - API V3 ------ diff --git a/docs/user/server-side-search/syntax.rst b/docs/user/server-side-search/syntax.rst index 8db8c31a9d2..579fd53e416 100644 --- a/docs/user/server-side-search/syntax.rst +++ b/docs/user/server-side-search/syntax.rst @@ -1,14 +1,9 @@ Search Query Syntax =================== -When searching on Read the Docs, you can use some parameters in your -query in order to search on given projects, versions, -or to get more accurate results. - -.. contents:: Table of contents - :local: - :backlinks: none - :depth: 3 +When searching on Read the Docs with :doc:`Server Side Search `, +you can use some parameters in your query +in order to search on given projects, versions, or to get more accurate results. Parameters ---------- From 03797887c7be1d279f6d9a04f29c09e71823b29d Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Fri, 20 Jan 2023 17:48:13 +0100 Subject: [PATCH 3/3] Add Server Side Search to feature reference --- docs/user/index.rst | 1 - docs/user/reference/features.rst | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/index.rst b/docs/user/index.rst index 489874f78ec..cd34cb0670a 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -87,7 +87,6 @@ to help you create fantastic documentation for your project. /single_version /science /commercial/organizations - /server-side-search/index .. toctree:: :maxdepth: 2 diff --git a/docs/user/reference/features.rst b/docs/user/reference/features.rst index 31f9aeb327e..73c79ddc212 100644 --- a/docs/user/reference/features.rst +++ b/docs/user/reference/features.rst @@ -7,3 +7,4 @@ Features :maxdepth: 1 analytics + /server-side-search/index