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

jfrost-mo · web-flow · commit 826d7576c250 · 2024-05-30T08:08:51.000-03:00
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
diff --git a/AUTHORS b/AUTHORS
@@ -188,6 +188,7 @@ Jake VanderPlas
 Jakob van Santen
 Jakub Mitoraj
 James Bourbeau
+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
@@ -316,6 +316,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 --------------------------------------------------
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+The documentation webpages now links to a canonical version to reduce outdated documentation in search engine results.`