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.

Sign up for GitHub

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

Jump to bottom

fix(docs): left sidebar expand by default #1722

Merged
merged 6 commits into from
Mar 4, 2021
Merged

fix(docs): left sidebar expand by default #1722

merged 6 commits into from
Mar 4, 2021

Conversation

ydcjeff
Copy link
Contributor

@ydcjeff ydcjeff commented Mar 1, 2021 •
edited
Loading

Fixes #1691 (comment)

Description: pytorch_sphinx_theme has recently changes for navbar expand or collapse by default.

  • Added var collapsedSections = ['Notes'] in script tag to make Notes collapse by default
  • Made padding = 0 to remove the gray footer
  • Commented out three dot in mobile view as they don't do anything
  • Commented out footer and div class='container' explicitly to have left side bar 100% height (you can still see the left sidebar when scrolling the engine page, on master docs, left sidebar disappear when scrolling to the end of engine page)

Check list:

  • New tests are added (if a new feature is added)
  • New doc strings: description and/or example code are in RST format
  • Documentation is updated (if required)

NOTE : This PR is blocked by pytorch/pytorch_sphinx_theme#97

Preview output built locally
Screen Shot 2021-03-02 at 00 39 40

@ydcjeff ydcjeff marked this pull request as draft March 1, 2021 18:28
@ydcjeff ydcjeff changed the title fix: navbar expand by default fix(docs): navbar expand by default Mar 1, 2021
vfdev-5
vfdev-5 approved these changes Mar 1, 2021
View reviewed changes
Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @ydcjeff !
Few questions and comments

docs/source/_templates/layout.html Outdated Show resolved Hide resolved
docs/source/_templates/_static/css/ignite_theme.css Show resolved Hide resolved
ignite/contrib/handlers/lr_finder.py Outdated Show resolved Hide resolved
ignite/utils.py Outdated Show resolved Hide resolved
@ydcjeff ydcjeff changed the title fix(docs): navbar expand by default fix(docs): left sidebar expand by default Mar 2, 2021
@ydcjeff ydcjeff marked this pull request as ready for review March 4, 2021 18:01
@ydcjeff ydcjeff requested a review from vfdev-5 March 4, 2021 18:08
@vfdev-5
Copy link
Collaborator

vfdev-5 commented Mar 4, 2021

@ydcjeff looks very neat now ! Thanks a lot for the improvements !

@vfdev-5 vfdev-5 merged commit 05728bb into pytorch:master Mar 4, 2021
@ydcjeff ydcjeff deleted the docs-nav branch March 5, 2021 02:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vfdev-5 vfdev-5 vfdev-5 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ydcjeff @vfdev-5