Sphinx Theme Adjustments
Open
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 52
- Forks
- 73
- Avg merge
- 4d 16m
- Merged PRs (30d)
- 8
Description
The items outlined below are a summary of a recent call with Allan and I.
The Sphinx theme should include the following elements:
- On mobile:
- Show library name & version dropdown selector in header
- All other links will be displayed in left sidebar menu
- Move right sidebar menu and search bar below header to match Docsy
- Show library name & version dropdown selector in header
- On desktop:
- Header should contain the following elements in the following left-to-right order:
- RAPIDS logo w/ chevron & dropdown menu showing main
rapids.ailinks - library name, which is a link to library's documentation homepage
- version dropdown selector
- library specific links
- RAPIDS logo w/ chevron & dropdown menu showing main
- Header should contain the following elements in the following left-to-right order:
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
Locate the Sphinx theme entry point and compare its mobile and desktop layout with the Docsy arrangement described here. Check how the header, sidebars, search bar, logo, library link, and version selector are currently assembled. Done means the specified ordering and responsive placement are implemented and verified on both mobile and desktop.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- design, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100