lincc-frameworks / lincc-frameworks/python-project-template
RTD template: switch to sphinx_book_theme HTML theme
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Jinja
- Stars
- 85
- Forks
- 16
- Avg merge
- 6h 18m
- Merged PRs (30d)
- 1
Description
`sphinx_book_theme` is used by hats/hats-import/lsdb/nested-pandas and it is really nice, let's use it for everything! It would probably help with #518 and #500
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 Read the Docs configuration in the template and review issues #518 and #500 for related requirements. Check how the current HTML theme is selected and update the template so generated projects use sphinx_book_theme consistently; done means the documentation builds with the new theme.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100