From 09573264a78110ffea0db5fd33b6b03bd2f18c43 Mon Sep 17 00:00:00 2001
From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
Date: Mon, 19 May 2025 16:39:14 +0200
Subject: [PATCH] docs: add linkcheck ignore (also through lychee)

---
 .gitignore    |  1 +
 .lycheeignore |  4 ++++
 conf.py       | 12 ++++++++++++
 3 files changed, 17 insertions(+)
 create mode 100644 .lycheeignore

diff --git a/.gitignore b/.gitignore
index f0a64e0b0..7d6309687 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,6 +7,7 @@ tmp/
 __pycache__
 *notes-from-review.md
 *.idea*
+*venv*
 # Grammar / syntax checkers
 styles/
 # Exclude translation .mo files
diff --git a/.lycheeignore b/.lycheeignore
new file mode 100644
index 000000000..cf19ab497
--- /dev/null
+++ b/.lycheeignore
@@ -0,0 +1,4 @@
+# List of links to ignore -- see https://lychee.cli.rs/recipes/excluding-links/
+#
+# All github.com links are excluded to avoid rate limiting
+https://github.com/
diff --git a/conf.py b/conf.py
index 04007608e..a13404583 100644
--- a/conf.py
+++ b/conf.py
@@ -160,3 +160,15 @@
     "line_color": "#6D597A",
     "image": "_static/pyopensci-logo-package-guide.png",
 }
+
+# -- Additional configuration for build process ------------------------------
+
+# Use the default linkcheck ignore list
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-linkcheck_ignore
+#
+# This is a list of regular expressions that match URIs to ignore when
+# doing linkcheck. Make sure to use raw strings (r"") for regexes. Also, any added
+# item should also be included in the .lycheeignore file.
+linkcheck_ignore = [
+    r"https://github.com/",
+]