-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Description
Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Docs currently don't include inheritance relations. For example, look at TextIOBase: https://docs.python.org/3.7/library/io.html#io.TextIOBase
The IOBase inheritance is manually described by the doc author in the first few lines of the documentation. This can lead to confusing docs if you forget this when writing them, as seen here: https://click.palletsprojects.com/en/7.x/api/#click.Argument
Additionally, this is a Don't Repeat Yourself issue, and could cause confusion if the inheritance relations say one thing but the docs say another.
Describe the solution you'd like
A clear and concise description of what you want to happen.
To solve this, Sphinx should include the inheritance relations automatically.
Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
The current alternative is writing the inheritance relations yourself in the documentation, instead of relying on the tool to do it for you.
Additional context
Add any other context or screenshots about the feature request here.
- [e.g. URL or Ticket]
Javadocs have inheritance relations.