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 theme (shortcuts improvements) #553

Merged
merged 1 commit into from
Feb 9, 2022

Conversation

jarrodmillman
Copy link
Member

@jarrodmillman jarrodmillman commented Feb 3, 2022

The shortcuts/sidebar has been fixed. It now doesn't scroll up with the rest of the page and the links work. It also makes the appearance more like what you see with pydata-sphinx-theme.

Old look

screenshot

New look

screenshot

@netlify
Copy link

netlify bot commented Feb 3, 2022

✔️ Deploy Preview for numpy-org ready!

🔨 Explore the source changes: 1749552

🔍 Inspect the deploy log: https://app.netlify.com/sites/numpy-org/deploys/61fc1e68dd1d25000782bebe

😎 Browse the preview: https://deploy-preview-553--numpy-org.netlify.app

@stefanv
Copy link
Contributor

stefanv commented Feb 3, 2022

scrolly-shortcuts

@stefanv
Copy link
Contributor

stefanv commented Feb 3, 2022

I should note that only h headers with ids will appear on the sidebar, and I see some of the NumPy headings don't; so that may be something else to fix in this PR, @jarrodmillman.

@jarrodmillman
Copy link
Member Author

I would rather keep the style and content changes separate. Maybe someone could fix the headings in a separate PR.

@stefanv
Copy link
Contributor

stefanv commented Feb 6, 2022

That works!

@stefanv
Copy link
Contributor

stefanv commented Feb 9, 2022

The sidebar generation is now much more consistent than it used to be, and I fixed some scrolling artifacts along the way. Let's merge this and if any issues arise we can fix those later. "Headings" (<p><strong>...</strong></p>) that don't show up in the sidebar will have to be changed to proper headings with IDs (<h2 id="something">something</h2>). This is the way Hugo generates headings by default, so as long as text is written in Markdown it will work out of the box. Hand-crafted HTML will need updating, but that was the case before this PR already.

@jarrodmillman
Copy link
Member Author

Just to be clear, the headings issue @stefanv mentioned is unrelated to this PR. The headings haven't changed.

@jarrodmillman jarrodmillman merged commit 469e780 into numpy:main Feb 9, 2022
@jarrodmillman jarrodmillman deleted the update-shortcuts branch March 14, 2022 19:12
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.

2 participants