DOC: document config value/kwarg

Author: rossbar

doc/install.rst

@@ -84,6 +84,21 @@ numpydoc_xref_ignore : set
         numpydoc_xref_ignore = {'type', 'optional', 'default'}
 
     The default is an empty set.
+numpydoc_xref_wrap_all : bool
+    Whether to wrap unrecognized terms in ``param_type`` in the default
+    ``:obj:`` role. The default is ``True``.
+    An unrecognized term is one that:
+      1. Is in neither ``numpydoc_xref_aliases`` nor ``numpydoc_xref_ignore``.
+      2. Is not already wrapped in a ReST role.
+
+    This configuration parameter may be useful if you only want create
+    cross references for a small set of terms. In this case, including the
+    desired cross reference mappings in ``numpydoc_xref_aliases`` and setting
+    ``numpydoc_xref_wrap_all = False`` is more convenient than adding all of
+    the non-linked terms to the ``numpydoc_xref_ignore`` set.
+
+    If ``numpydoc_xref_param_type`` is set to ``False``, this config parameter
+    has no effect.
 numpydoc_edit_link : bool
   .. deprecated:: edit your HTML template instead
 

numpydoc/xref.py

@@ -108,6 +108,11 @@ def make_xref(param_type, xref_aliases, xref_ignore, wrap_unknown=True):
         to fully qualified names that can be cross-referenced.
     xref_ignore : set
         Words not to cross-reference.
+    wrap_unknown : bool, default=True
+        Toggle whether to wrap unrecognized terms in the default :obj: role,
+        default is `True`. Unrecognized terms include those that are in
+        neither `xref_aliases` nor `xref_ignore` and are not already wrapped
+        in an rST role.
 
     Returns
     -------