Lightning-AI / Lightning-AI/lightning-thunder
sphinx upgrade for documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 121
- PR merge metrics
- No merged PRs in 30d
Description
We are currently running on Sphinx 5 and likely need to bump to 7 or so at some point.
(For reference Debian stable has 5.x but testing - which would be expected to release late 2024 / early 2026 has 7.2.)
Contributor guide
No contributing guide indexed for this repository
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 documentation build configuration and dependency declaration that currently pin or invoke Sphinx 5. Check whether the project can build its documentation with Sphinx 7, then update the documented or configured version as needed. Done means the documentation build succeeds with the newer Sphinx version.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100