From 71511e1a79fbd1240cf26f276144d7967b709e7f Mon Sep 17 00:00:00 2001 From: Yuki Kobayashi Date: Sat, 7 Jun 2025 00:22:57 +0000 Subject: [PATCH] Specity the types of `numpydoc_xref_ignore` option Added `types` parameter to accept the value `"all"` for the `numpydoc_xref_ignore` option. Fixes gh-630 --- numpydoc/numpydoc.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/numpydoc/numpydoc.py b/numpydoc/numpydoc.py index a04443b3..9a920e35 100644 --- a/numpydoc/numpydoc.py +++ b/numpydoc/numpydoc.py @@ -296,7 +296,7 @@ def setup(app, get_doc_object_=get_doc_object): app.add_config_value("numpydoc_attributes_as_param_list", True, True) app.add_config_value("numpydoc_xref_param_type", False, True) app.add_config_value("numpydoc_xref_aliases", dict(), True) - app.add_config_value("numpydoc_xref_ignore", set(), True) + app.add_config_value("numpydoc_xref_ignore", set(), True, types=[set, str]) app.add_config_value("numpydoc_validation_checks", set(), True) app.add_config_value("numpydoc_validation_exclude", set(), False) app.add_config_value("numpydoc_validation_overrides", dict(), False)