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

Add Previous Releases feature to Furo #384

Merged
merged 5 commits into from Jun 19, 2023
Merged

Conversation

Eric-Arellano
Copy link
Collaborator

Closes #381.

The implementation mostly reuses our code for translations (#380).

See #355 for an explanation of why we diverge Furo's standard approach of the top-level entry being clickable and going to a dedicated HTML page. Instead, we have the entry look like a sidebar entry, and still have the entire div be clickable.

Reduces padding for translations

This reduces padding for the translations header, which aligns it with the rest of the sidebar entries. I'm not sure why I had set up so much padding before.

@SooluThomas and I thought this is a cleaner design, and that it takes less screen real estate. But we can add back the padding if people want.

Tweaks example_docs table of contents

To make our example docs more clear, this adds a new Special Elements section. On Pytorch, that results in the ToC looking like this:

pytorch-sidebar

Copy link
Collaborator

@javabster javabster left a comment

Choose a reason for hiding this comment

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

overall looks good, just one small thing: now that we have reduced the size of languages padding it now looks like the searchbar is a bit too squished up to the top. I would recommend adjusting the spacing so there is an equal amount of padding above and below the search bar, so either increase the padding between the languages and searchbar or decrease the padding between searchbar and "documentation home"

Copy link
Collaborator

@javabster javabster left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@Eric-Arellano Eric-Arellano merged commit 765c936 into main Jun 19, 2023
5 checks passed
@Eric-Arellano Eric-Arellano deleted the EA/furo-previous-releases branch June 19, 2023 19:19
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.

Furo: add Previous Releases feature
2 participants