DOC: update sphinx and numpydoc pins
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 32.8k
- Forks
- 12.8k
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 197
Description
Currently sphinx and numpydoc are pinned to old versions in the requirements file:
Numpydoc 1.4 is from 2022 and Sphinx 7.2.6 is from 2023.
It would behoove us to update these to the current versions so our documentation build configuration doesn't hopelessly bitrot.
I tried updating these pins in #30683 but punted when the update proved nontrivial. The build does succeed, but with more than a thousand warnings: https://gist.github.com/ngoldbaum/ad5e476401a591d378df406e2bcfaada
https://github.com/numpy/numpy/issues/28694 is related too - that's using a sphinx version newer than our pin.
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 with requirements/doc_requirements.txt lines 2–3 and reproduce the documentation build using newer Sphinx and numpydoc versions. Review the warning output from the linked gist and related issues, then consider the work done when the pins are updated and the build no longer produces the reported warning volume.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100