docs: ignore warnings about missing external py xrefs (bazel-contrib#2904)

rickeylev · aignas · web-flow · commit 6ffeff643ad7 · 2025-05-18T12:01:58.000Z
Crossreferencing to py code outside our project isn't setup, so these
are just a lot
of warning spam. Disable them for now.

Co-authored-by: Ignas Anikevicius &lt;240938+aignas@users.noreply.github.com&gt;
diff --git a/docs/conf.py b/docs/conf.py
@@ -125,6 +125,12 @@
 primary_domain = None  # The default is 'py', which we don't make much use of
 nitpicky = True
 
+nitpick_ignore_regex = [
+    # External xrefs aren't setup: ignore missing xref warnings
+    # External xrefs to sphinx isn't setup: ignore missing xref warnings
+    ("py:.*", "(sphinx|docutils|ast|enum|collections|typing_extensions).*"),
+]
+
 # --- Intersphinx configuration
 
 intersphinx_mapping = {
