Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs template #412

Merged
merged 5 commits into from
Nov 18, 2024
Merged

Update docs template #412

merged 5 commits into from
Nov 18, 2024

Conversation

becky-gilbert
Copy link
Contributor

@becky-gilbert becky-gilbert commented Nov 14, 2024

Partially fixes lookit/lookit-docs#435 (but still need to make the same update on the CHS jsPsych page).

Summary

This PR updates the RTD theme and removes the need for the forked theme. Instead, I've used a custom template to add the navigation 'tabs' at the top of left-hand navigation menu. These tabs contain links to the other docs pages (CHS main docs and CHS jsPsych).

Here are the changes:

  • Remove custom forked sphinx-rtd-theme and use standard sphinx-rtd-theme
  • Add custom navigation 'tabs' with the _templates/layout.html file to match those on the main CHS docs site
  • Update project title to "Lookit Ember Frameplayer" for consistency with main docs terms
  • Update python requirements file
  • Comment out the notes in JS code blocks (prevents build errors and improves syntax highlighting)

Screenshots

NEW - homepage with navigation tabs:

Screenshot 2024-11-14 at 3 15 01 PM

Current version, for reference:

Screenshot 2024-11-14 at 3 59 06 PM

NEW - JS code blocks with commented-out notes:

Screenshot 2024-11-14 at 3 55 45 PM

Current version, for reference:

Screenshot 2024-11-14 at 3 56 36 PM

@becky-gilbert becky-gilbert merged commit 7d0fb7e into develop Nov 18, 2024
becky-gilbert added a commit that referenced this pull request Nov 22, 2024
* Update docs template (#412)
* Fix/309 ajv compile frame schema error (#328)
* Add error catching/logging for recording start and stop/upload problems (#402)
* Replace links to old docs site with current links (#416)

---------

Co-authored-by: Victor Antoine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

STRUCTURE - Disappearing tabs as of 10/22 morning
2 participants