Docs: Eng / Design Improvements for the Q3 2024

[dgmccart]

Running list of design / eng improvements for the docs sites:

Theme / Figures

• [x] Update theme to sphinx-immaterial #889(Designs for mkdocs version of this theme)
• [ ] Add data schema graphic to the site
• [x] Enable dark mode
• [ ] Set up method for changing figures for dark mode
• [x] Specify alignment of figures on the site (e.g. center justified)

Navigation

• [x] Add hierarchy to the table of contents (e.g. tutorials landing page with sub-pages) (jump-to-navigation) - break into 2 items

• [x] Fix anchor linking so that the section header isn't cuts off when the hyperlink is clicked) #888

• [ ] Function to open accordions from links - needs exploration

• [ ] Accordion styling

• [ ] Implement cards / tiles design element (e.g. see below) - comes for free from site theme

  

• [x] Add indicator to the sidebar of where you are when scrolling the page (e.g. see below where the right side bar uses grey or black coloring to indicate where the user is on the page)

  

API Reference

• [ ] Improve data model graphic (e.g. create an interactive data model graphic) P0 is address this issue
• [ ] Custom examples of inherited functions in API documentation #890 - needs exploration
• [ ] Improve styling and navigation of API docs following the update to sphinx-immaterial theme
• [ ] Versioned docs
• [x] Syntax highlighting in code blocks for python and JSON
• [x] Alphabetize API reference #944

[dgmccart]

Start with updating theme, and then move on the API study recommendations related items.