matrix-org / matrix-org/matrix-python-sdk
Don't pin documentation dependency versions
Open
Nobody has claimed this yet.
documentation
good first issue
- Dominant language
- Python
- Stars
- 266
- Forks
- 118
- PR merge metrics
- No merged PRs in 30d
Description
Unless really necessary, we shouldn't be pinning any versions of our dependencies. This should be as simple as removing the version pins in setup.py for the Sphinx stuff and making sure the documentation generated is still sane.
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
Inspect setup.py for the Sphinx dependency version pins and review how the documentation is generated. Remove the pins unless they are necessary, then generate the documentation and verify that the output remains sane.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100