Add html_baseurl to sphinx conf.py (#12364) (#12396)

This is used to set the <link rel="canonical" href="X"> 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
pytest-dev · May 30, 2024 · aa6f97d · aa6f97d
1 parent 20f1c95
commit aa6f97d
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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 --------------------------------------------------