Skip to content

DOC: fix erroneous numpydoc_edit_link formatting #309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 21, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 22 additions & 20 deletions doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,26 +77,28 @@ numpydoc_xref_aliases : dict
This option depends on the ``numpydoc_xref_param_type`` option
being ``True``.
numpydoc_xref_ignore : set or ``"all"``
How to handle terms not in ``numpydoc_xref_aliases`` when
``numpydoc_xref_aliases=True``. The value can either be a ``set``
containing terms to ignore, or ``"all"``. In the former case, the set
contains words not to cross-reference. Most likely, these are common words
used in parameter type descriptions that may be confused for
classes of the same name. For example::

numpydoc_xref_ignore = {'type', 'optional', 'default'}

The default is an empty set.

If the ``numpydoc_xref_ignore="all"``, then all unrecognized terms are
ignored, i.e. terms not in ``numpydoc_xref_aliases`` are *not* wrapped in
``:obj:`` roles.
This configuration parameter may be useful if you only want create
cross references for a small number of terms. In this case, including the
desired cross reference mappings in ``numpydoc_xref_aliases`` and setting
``numpydoc_xref_ignore="all"`` is more convenient than explicitly listing
terms to ignore in a set.
How to handle terms not in ``numpydoc_xref_aliases`` when
``numpydoc_xref_aliases=True``. The value can either be a ``set``
containing terms to ignore, or ``"all"``. In the former case, the set
contains words not to cross-reference. Most likely, these are common words
used in parameter type descriptions that may be confused for
classes of the same name. For example::

numpydoc_xref_ignore = {'type', 'optional', 'default'}

The default is an empty set.

If the ``numpydoc_xref_ignore="all"``, then all unrecognized terms are
ignored, i.e. terms not in ``numpydoc_xref_aliases`` are *not* wrapped in
``:obj:`` roles.
This configuration parameter may be useful if you only want create
cross references for a small number of terms. In this case, including the
desired cross reference mappings in ``numpydoc_xref_aliases`` and setting
``numpydoc_xref_ignore="all"`` is more convenient than explicitly listing
terms to ignore in a set.
numpydoc_edit_link : bool
.. deprecated:: edit your HTML template instead
.. deprecated:: 0.7.0

edit your HTML template instead

Whether to insert an edit link after docstrings.