diff options
| -rw-r--r-- | doc/install.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/install.rst b/doc/install.rst index d195f7b..0425ba8 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -88,8 +88,9 @@ 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. + + 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 |