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

Test out sphinx-autodoc-typehints extension #2549

Open
dgw opened this issue Nov 9, 2023 · 0 comments
Open

Test out sphinx-autodoc-typehints extension #2549

dgw opened this issue Nov 9, 2023 · 0 comments
Milestone

Comments

@dgw
Copy link
Member

dgw commented Nov 9, 2023

I have an idea on my list from ages ago to see if the sphinx-autodoc-typehints extension improves our docs.

For one thing, it could improve our parameter lists. It might also help with the warnings Sphinx currently spits out for some of the type hints in signatures scattered around, but that seems unlikely at best. (The extension appears to add :type: and :rtype: annotations to the rST source before Sphinx renders it, which wouldn't affect how the problematic types are resolved. Most likely we need to wait on sphinx-doc/sphinx#10785 and/or sphinx-doc/sphinx#10974 to actually fix those warnings.)

Don't want to spend time on this before 8.0.0 is out, but also don't want to forget about it once we start on 8.0.1. Documentation tweaks are great candidates for maintenance releases.

@dgw dgw added this to the 8.0.1 milestone Nov 9, 2023
@dgw dgw modified the milestones: 8.0.1, 8.1.0 Oct 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant