DOC, MAINT: Turn on version warning banner provided by PyData Sphinx Theme

melissawm · melissawm · commit 37745f2d3774 · 2024-06-17T10:41:03.000-03:00
After numpy/doc#25, this will show a warning banner for past and unreleased versions of the docs. See https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/announcements.html#version-warning-banners The warning banner can be dismissed by the user.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -266,6 +266,7 @@ def setup(app):
         "version_match": switcher_version,
         "json_url": "https://numpy.org/doc/_static/versions.json",
     },
+    "show_version_warning_banner": True,
 }
 
 html_title = "%s v%s Manual" % (project, version)

Original file line number	Diff line number	Diff line change
`@@ -266,6 +266,7 @@ def setup(app):`
`266`	`266`	`"version_match": switcher_version,`
`267`	`267`	`"json_url": "https://numpy.org/doc/_static/versions.json",`
`268`	`268`	`},`
	`269`	`+ "show_version_warning_banner": True,`
`269`	`270`	`}`
`270`	`271`
`271`	`272`	`html_title = "%s v%s Manual" % (project, version)`