We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
See Also
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
The See Also section should be explicitly allowed to contain references to any object.
The current situation is murky:
numpydoc
numpydoc.docscrape
:func:
This causes problems for example with numpy/numpy#28734. This works with intersphinx:
def f(): """ See Also -------- numpy.logaddexp """
However, a round-trip through docscrape breaks it:
def f(): """ See Also -------- numpy.logaddexp """ from numpydoc.docscrape import FunctionDoc f.__doc__ = str(FunctionDoc(f))
Now f.__doc__ has been changed to
f.__doc__
.. function:: f See Also -------- :func:`numpy.logaddexp` ..
Which encroaches on numpy/numpy#28734 and breaks the rendering, because numpy.logaddexp is actually a py:data object.
py:data
The text was updated successfully, but these errors were encountered:
:data:
special
xp_capabilities
No branches or pull requests
The
See Also
section should be explicitly allowed to contain references to any object.The current situation is murky:
https://numpydoc.readthedocs.io/en/latest/format.html#see-also
numpydoc
parses untagged entries in the section to match anythingnumpydoc.docscrape
automatically adds the:func:
tag to untagged entries, but otherwise accepts other entries.This causes problems for example with numpy/numpy#28734.
This works with intersphinx:
However, a round-trip through docscrape breaks it:
Now
f.__doc__
has been changed toWhich encroaches on numpy/numpy#28734 and breaks the rendering, because numpy.logaddexp is actually a
py:data
object.The text was updated successfully, but these errors were encountered: