Add config value to control behavior

Author: rossbar

numpydoc/docscrape_sphinx.py

@@ -30,6 +30,7 @@ def load_config(self, config):
         self.xref_param_type = config.get('xref_param_type', False)
         self.xref_aliases = config.get('xref_aliases', dict())
         self.xref_ignore = config.get('xref_ignore', set())
+        self.xref_wrap_all = config.get('xref_wrap_all', True)
         self.template = config.get('template', None)
         if self.template is None:
             template_dirs = [os.path.join(os.path.dirname(__file__), 'templates')]
@@ -77,7 +78,9 @@ def _str_returns(self, name='Returns'):
                     param_type = make_xref(
                         param_type,
                         self.xref_aliases,
-                        self.xref_ignore)
+                        self.xref_ignore,
+                        self.xref_wrap_all
+                    )
                 if param.name:
                     out += self._str_indent([named_fmt % (param.name.strip(),
                                                           param_type)])
@@ -217,7 +220,9 @@ def _str_param_list(self, name, fake_autosummary=False):
                         param_type = make_xref(
                             param_type,
                             self.xref_aliases,
-                            self.xref_ignore)
+                            self.xref_ignore,
+                            self.xref_wrap_all
+                        )
                     parts.append(param_type)
                 out += self._str_indent([' : '.join(parts)])
 

numpydoc/numpydoc.py

@@ -155,6 +155,7 @@ def mangle_docstrings(app, what, name, obj, options, lines):
            'xref_param_type': app.config.numpydoc_xref_param_type,
            'xref_aliases': app.config.numpydoc_xref_aliases_complete,
            'xref_ignore': app.config.numpydoc_xref_ignore,
+           'xref_wrap_all': app.config.numpydoc_xref_wrap_all,
            }
 
     cfg.update(options or {})
@@ -254,6 +255,7 @@ def setup(app, get_doc_object_=get_doc_object):
     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_wrap_all', True, True)
 
     # Extra mangling domains
     app.add_domain(NumpyPythonDomain)

numpydoc/tests/test_numpydoc.py

@@ -15,6 +15,7 @@ class MockConfig():
     numpydoc_xref_aliases = {}
     numpydoc_xref_aliases_complete = deepcopy(DEFAULT_LINKS)
     numpydoc_xref_ignore = set()
+    numpydoc_xref_wrap_all = True
     templates_path = []
     numpydoc_edit_link = False
     numpydoc_citation_re = '[a-z0-9_.-]+'