Add stackoverflow.com/help/* links to linkcheck_ignore (#559)

* add stackoverflow.com/help/* links to linkcheck_ignore * add to release notes
NCAR · Feb 21, 2024 · 94de20a · 94de20a
1 parent 8266a4f
commit 94de20a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -399,6 +399,9 @@ def update_gallery(app: Sphinx):
 # generate warning for all invalid links
 # nitpicky = True
 
+# add links to ignore during link checking
+linkcheck_ignore = [r'https://stackoverflow.com/help/*']
+
 
 # Allow for changes to be made to the css in the theme_overrides file
 def setup(app):

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
@@ -17,6 +17,7 @@ Internal Changes
 * Update hourly frequency aliases by `Katelyn FitzGerald`_ in (:pr:`550`)
 * Python 3.12 Support by `Cora Schneck`_ in (:pr:`548`)
 * Temporarily pin ASV to ``<0.6.2`` by `Anissa Zacharias`_ in (:pr:`556`)
+* Added ``linkcheck_ignore`` to ``docs/conf.py`` to address erroneous failures `Anissa Zacharias`_ in (:pr:`559`)
 
 
 v2024.01.0 (January 30, 2023)