@@ -77,26 +77,28 @@ numpydoc_xref_aliases : dict
77
77
This option depends on the ``numpydoc_xref_param_type `` option
78
78
being ``True ``.
79
79
numpydoc_xref_ignore : set or ``"all" ``
80
- How to handle terms not in ``numpydoc_xref_aliases `` when
81
- ``numpydoc_xref_aliases=True ``. The value can either be a ``set ``
82
- containing terms to ignore, or ``"all" ``. In the former case, the set
83
- contains words not to cross-reference. Most likely, these are common words
84
- used in parameter type descriptions that may be confused for
85
- classes of the same name. For example::
86
-
87
- numpydoc_xref_ignore = {'type', 'optional', 'default'}
88
-
89
- The default is an empty set.
90
-
91
- If the ``numpydoc_xref_ignore="all" ``, then all unrecognized terms are
92
- ignored, i.e. terms not in ``numpydoc_xref_aliases `` are *not * wrapped in
93
- ``:obj: `` roles.
94
- This configuration parameter may be useful if you only want create
95
- cross references for a small number of terms. In this case, including the
96
- desired cross reference mappings in ``numpydoc_xref_aliases `` and setting
97
- ``numpydoc_xref_ignore="all" `` is more convenient than explicitly listing
98
- terms to ignore in a set.
80
+ How to handle terms not in ``numpydoc_xref_aliases `` when
81
+ ``numpydoc_xref_aliases=True ``. The value can either be a ``set ``
82
+ containing terms to ignore, or ``"all" ``. In the former case, the set
83
+ contains words not to cross-reference. Most likely, these are common words
84
+ used in parameter type descriptions that may be confused for
85
+ classes of the same name. For example::
86
+
87
+ numpydoc_xref_ignore = {'type', 'optional', 'default'}
88
+
89
+ The default is an empty set.
90
+
91
+ If the ``numpydoc_xref_ignore="all" ``, then all unrecognized terms are
92
+ ignored, i.e. terms not in ``numpydoc_xref_aliases `` are *not * wrapped in
93
+ ``:obj: `` roles.
94
+ This configuration parameter may be useful if you only want create
95
+ cross references for a small number of terms. In this case, including the
96
+ desired cross reference mappings in ``numpydoc_xref_aliases `` and setting
97
+ ``numpydoc_xref_ignore="all" `` is more convenient than explicitly listing
98
+ terms to ignore in a set.
99
99
numpydoc_edit_link : bool
100
- .. deprecated :: edit your HTML template instead
100
+ .. deprecated :: 0.7.0
101
+
102
+ edit your HTML template instead
101
103
102
104
Whether to insert an edit link after docstrings.
0 commit comments