Skip to content
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

Use autodoc-process-bases to substitute TypeVars for their bounds in base classes in docs #734

Open
tp832944 opened this issue Aug 14, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@tp832944
Copy link
Contributor

What's the new feature?

Use autodoc-process-bases to substitute TypeVars for their bounds in base classes in docs. This is similar to the existing function to do it in function annotations.

See documentation/source/conf.py and https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#event-autodoc-process-bases.

What value does this add?

Show inheritance with Intersphinx links without needing to include TypeVars in the compiled documentation. Currently these links are broken.

Is there an alternative you've considered?

No response

Additional context

No response

@tp832944 tp832944 added enhancement New feature or request new Something yet to be discussed by development team and removed new Something yet to be discussed by development team labels Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant