Improving type annotations in Sphinx
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5.1k
- Forks
- 2.1k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 82
Description
@JelleZijlstra, @srittau thanks for all your help with the docutils type stubs.
The point of all these PRs is facilitate migrating the venerable Sphinx project from docutils-stubs to types-docutils.
There's a PR for that here - https://github.com/sphinx-doc/sphinx/pull/12012
there's still a number of errors remaining. Some are issues with Sphinx, others with the type annotations themselves.
I wonder if you have any bandwidth to help me get this PR over the line, and get Sphinx using typeshed once and for all?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the Sphinx PR #12012 and the remaining errors described there. Compare the docutils-stubs and types-docutils annotations while determining which errors belong to Sphinx and which belong to the type annotations. Done means the remaining errors are addressed and Sphinx can use typeshed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- devtools
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100