From 3cb9a704c2497dc3c873cc3a11acbc326d49fd3b Mon Sep 17 00:00:00 2001 From: Patrick Avery Date: Fri, 25 Mar 2022 10:03:39 -0500 Subject: [PATCH] Fix undefined link suffix for v5.9 and v5.10 This issue was caused by too new of a version of sphinx being used with too old of a version of sphinx_rtd_theme, for which we have a copy residing in ParaView. The older sphinx_rtd_theme was unaware of the `DOCUMENTATION_OPTIONS.LINK_SUFFIX`, and it therefore was undefined. This is the same fix performed in `fish-shell` in [this commit](https://github.com/fish-shell/fish-shell/commit/58885fbd0ba6b2b414bcf897f6226fe5419e2c05). The issue would cause broken search result links, where clicking on a link would include "undefined" in the url. This patch seems to fix the issue. Signed-off-by: Patrick Avery --- v5.10.0/python/_static/searchtools.js | 3 ++- v5.10.1/python/_static/searchtools.js | 3 ++- v5.9.0/python/_static/searchtools.js | 3 ++- v5.9.1/python/_static/searchtools.js | 3 ++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/v5.10.0/python/_static/searchtools.js b/v5.10.0/python/_static/searchtools.js index 970d0d9756053..a81c342077911 100644 --- a/v5.10.0/python/_static/searchtools.js +++ b/v5.10.0/python/_static/searchtools.js @@ -265,7 +265,8 @@ var Search = { } else { // normal html builders requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX; - linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX; + // If LINK_SUFFIX is undefined, default to ".html" + linkUrl = item[0] + (DOCUMENTATION_OPTIONS.LINK_SUFFIX || ".html"); } listItem.append($('').attr('href', linkUrl + diff --git a/v5.10.1/python/_static/searchtools.js b/v5.10.1/python/_static/searchtools.js index 970d0d9756053..a81c342077911 100644 --- a/v5.10.1/python/_static/searchtools.js +++ b/v5.10.1/python/_static/searchtools.js @@ -265,7 +265,8 @@ var Search = { } else { // normal html builders requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX; - linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX; + // If LINK_SUFFIX is undefined, default to ".html" + linkUrl = item[0] + (DOCUMENTATION_OPTIONS.LINK_SUFFIX || ".html"); } listItem.append($('').attr('href', linkUrl + diff --git a/v5.9.0/python/_static/searchtools.js b/v5.9.0/python/_static/searchtools.js index 970d0d9756053..a81c342077911 100644 --- a/v5.9.0/python/_static/searchtools.js +++ b/v5.9.0/python/_static/searchtools.js @@ -265,7 +265,8 @@ var Search = { } else { // normal html builders requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX; - linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX; + // If LINK_SUFFIX is undefined, default to ".html" + linkUrl = item[0] + (DOCUMENTATION_OPTIONS.LINK_SUFFIX || ".html"); } listItem.append($('').attr('href', linkUrl + diff --git a/v5.9.1/python/_static/searchtools.js b/v5.9.1/python/_static/searchtools.js index 970d0d9756053..a81c342077911 100644 --- a/v5.9.1/python/_static/searchtools.js +++ b/v5.9.1/python/_static/searchtools.js @@ -265,7 +265,8 @@ var Search = { } else { // normal html builders requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX; - linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX; + // If LINK_SUFFIX is undefined, default to ".html" + linkUrl = item[0] + (DOCUMENTATION_OPTIONS.LINK_SUFFIX || ".html"); } listItem.append($('').attr('href', linkUrl +