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
Drop special cross reference helper for exceptions, functions and methods #7246
Labels
Milestone
Comments
+1 to drop special cross reference helper |
Note: python-docs declares exceptions classes as root item (not under builtins package):
|
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Mar 7, 2020
…ions, functions and methods
tk0miya
added a commit
that referenced
this issue
Mar 8, 2020
Close #7246: Drop special cross reference helper for exceptions, functions and methods
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Is your feature request related to a problem? Please describe.
So far,
:py:exc:
role automatically searches exception classes underexceptions
module. But, since python3, exception classes has been moved intobuiltins
module. So this fallback works fine only for python2 docs.In addition, this fallback is a part of python domain, not intersphinx. So it only works for a document contains descriptions for standard exceptions. It does not work for a document only refers python standard exceptions.
Side note: python domain also has another special support for
:py:func:
and:py:meth:
. It also automatically searches functions and methods underobject
.I don't know why python domain searches them on
object.*
namespace. I can understand if it searches underbuiltins
module. Anyway, this is also meaningless.Describe the solution you'd like
Drop these special treatment from python domain.
Describe alternatives you've considered
Nothing.
Additional context
Nothing.
The text was updated successfully, but these errors were encountered: