docs: ignore warnings about missing external py xrefs (#2904)
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 <240938+aignas@users.noreply.github.com>
diff --git a/docs/conf.py b/docs/conf.py
index f58baf5..96bbdb5 100644
--- 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 = {