openedx / openedx/openedx-platform
Drop sphinx-autoapi Constraint
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
On python 3.11 sphinx-autoapi requires astroid=~3 however it's fully functional with newer versions of astroids. Once we move to Python 3.12 as the default requirements builder python version, we can unpin this constraint.
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
Search the requirements and builder configuration for the sphinx-autoapi and astroid version constraint. First confirm that Python 3.12 is the default requirements-builder version, then remove the constraint and run the requirements build. Done means the build succeeds with newer astroid versions and no longer pins the old constraint.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100