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

⬆ UPGRADE: Pydata Sphinx Theme v0.6.0 #324

Merged
merged 5 commits into from
Apr 22, 2021

Conversation

choldgraf
Copy link
Member

@choldgraf choldgraf commented Apr 9, 2021

This is a first pass at upgrading to the latest pydata sphinx theme, and removing our custom sidebar collapsing code to use it instead. This should remove a bunch of our CSS + __init__.py code, as well as some testing infrastructure for the sidebar collapsing logic.

Note - this will remove one feature for us, which is navbar_depth = 0. This would have removed all navbar items except for captions (and made them collapsible). The pydata theme does not support collapsible captions so this will remove this functionality. That said:

  • I did a github search and couldn't find any configuration that was using navbar_depth = 0
  • I also looked through the Jupyter Book docs and don't think we've documented that anywhere

so I think it is OK to remove, but welcome others suggesting otherwise!

closes #323

ToDo

  • Make the tests pass
  • Make sure that the visual look is the same as it was before (or better)
  • Review to make sure the look is correct, and we're not missing anything

@choldgraf choldgraf added this to Ready for Work in Berkeley dev priorities Apr 10, 2021
@choldgraf choldgraf force-pushed the pydata-update branch 2 times, most recently from 14a7530 to 3de44de Compare April 21, 2021 02:32
@choldgraf
Copy link
Member Author

OK updated the tests and cleaned up some of the code. I think that this is ready to go whenever we'd like to merge.

@DrDrij let me know if you'd like me to hold off merging so that this doesn't mess with some work you're doing.

Also speak now @executablebooks/ebpteam if you really wanted to be able to collapse the sidebar TOC entirely (so that only captions are shown and no links) via navigation_depth = 0 since that is being removed here.

@choldgraf choldgraf marked this pull request as ready for review April 22, 2021 17:11
@choldgraf choldgraf changed the title First pass at upgrading pst ⬆ UPGRADE: Pydata Sphinx Theme v0.6.0 Apr 22, 2021
@choldgraf choldgraf merged commit 8a03bb7 into executablebooks:master Apr 22, 2021
Berkeley dev priorities automation moved this from Ready for Work to Done Apr 22, 2021
@choldgraf choldgraf deleted the pydata-update branch April 22, 2021 17:12
@@ -12,17 +12,6 @@
transition: margin-left .2s ease 0s, opacity .2s ease 0s, visibility .2s ease 0s;
z-index: 2000 !important;

&.collapse {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@choldgraf These styles add the slide animation to left sidebar.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Refactor sidebar logic to use the PyData Sphinx Theme
3 participants