OpenFreeEnergy / OpenFreeEnergy/openfe
migrate to sphinx v9
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 332
- Forks
- 56
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 13
Description
we're currently pinned to v7, which causes headaches such as https://github.com/OpenFreeEnergy/gufe/pull/803
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 locating the project’s Sphinx dependency pin and documentation build configuration; no specific files or tests are named in the issue. Review the linked gufe pull request for the compatibility problems, update the pin to Sphinx v9, and verify that the documentation build completes without the reported headaches.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100