From aa6f97d6cdb260078993b35566911fd5ed18949f Mon Sep 17 00:00:00 2001 From: James Frost Date: Thu, 30 May 2024 12:09:40 +0100 Subject: [PATCH] Add html_baseurl to sphinx conf.py (#12364) (#12396) This is used to set the tag that points to the canonical version of the webpage. Including this indicates to search engines which version to include in their indexes, and should prevent older versions showing up. Fixes #12363 --- AUTHORS | 1 + changelog/12363.doc.rst | 1 + doc/en/conf.py | 3 +++ 3 files changed, 5 insertions(+) create mode 100644 changelog/12363.doc.rst diff --git a/AUTHORS b/AUTHORS index a066159d23..cc9a9c2d0e 100644 --- a/AUTHORS +++ b/AUTHORS @@ -137,6 +137,7 @@ Iwan Briquemont Jaap Broekhuizen Jakob van Santen Jakub Mitoraj +James Frost Jan Balster Janne Vanhala Jason R. Coombs diff --git a/changelog/12363.doc.rst b/changelog/12363.doc.rst new file mode 100644 index 0000000000..c657281bab --- /dev/null +++ b/changelog/12363.doc.rst @@ -0,0 +1 @@ +The documentation webpages now links to a canonical version to reduce outdated documentation in search engine results. diff --git a/doc/en/conf.py b/doc/en/conf.py index 2f3a2baf44..6c8845bfa2 100644 --- a/doc/en/conf.py +++ b/doc/en/conf.py @@ -235,6 +235,9 @@ # Output file base name for HTML help builder. htmlhelp_basename = "pytestdoc" +# The base URL which points to the root of the HTML documentation. It is used +# to indicate the location of document using the canonical link relation (#12363). +html_baseurl = "https://docs.pytest.org/en/stable/" # -- Options for LaTeX output --------------------------------------------------