[8.2.x] Add html_baseurl to sphinx conf.py (#12372)

Co-authored-by: James Frost <james.frost@metoffice.gov.uk>
pytest-dev · May 26, 2024 · 240a252 · 240a252
1 parent a5ee3c4
commit 240a252
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -192,6 +192,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
@@ -312,6 +312,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 --------------------------------------------------