From fbed0431c26fe9ce995cbc644161c4ea05ab41ed Mon Sep 17 00:00:00 2001
From: Brad King <brad.king@kitware.com>
Date: Wed, 9 Aug 2023 19:47:32 -0400
Subject: ci: Suppress cmake.org html documentation search results for index
entries
Since Sphinx 5.2.0, the generated html search page reports all index
entries that match a query term. Unfortunately even non-main entries
get a high score, placing them before more important search results
such as document titles and domain object names.
Work around this for documentation published on `cmake.org` by removing
the logic from `searchtools.js` in the generated html documentation.
Issue: #25175
---
.gitlab/os-linux.yml | 2 ++
1 file changed, 2 insertions(+)
diff --git a/.gitlab/os-linux.yml b/.gitlab/os-linux.yml
index 79217ee..23ec481 100644
--- a/.gitlab/os-linux.yml
+++ b/.gitlab/os-linux.yml
@@ -622,3 +622,5 @@
-DCMake_SPHINX_CMAKE_ORG_OUTDATED=$CMAKE_CI_SPHINX_OUTDATED
-DCMake_VERSION_NO_GIT=$CMAKE_CI_VERSION_NO_GIT
- ninja
+ # FIXME(#25175): non-main index entries are scored too high.
+ - sed -i '/search for explicit entries in index directives/,/^$/d' html/_static/searchtools.js
--
cgit v0.12