-
-
Notifications
You must be signed in to change notification settings - Fork 168
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
Hide primary sidebar from certain pages of the documentation #2424
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2424 +/- ##
=======================================
Coverage 98.32% 98.32%
=======================================
Files 87 87
Lines 4048 4048
=======================================
Hits 3980 3980
Misses 68 68 ☔ View full report in Codecov by Sentry. |
My only concern is the one raised by @natestemen, that is, the content view moving around may be distracting for users. Frances, the views to compare are: Downside of (2): the API-doc page has an empty Section navigation bar on the left |
That's understandable. The content does move around on its own with the current version of the docs and I don't really know what the fix for it would be. If you are having issues with the screencast video in the PR description, search for |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO it's not ideal how content jumps around when switching to these pages, but it's nice not to have the sidebars when there is nothing in them.
It's wild how many options there are for configuration in sphinx!
Should we create a separate issue for this? |
Description
Remove the left sidebar from
API-doc
,Changelog
, andReferences
because the primary sidebar is blank.Related to #2331 where we want to hide the blank sidebar on the left for some pages of the documentation.
Note that the behavior from #2405 (comment) is still present even if we hide the primary sidebar.
This is not fixable by
navigation_with_keys=False
which makes me think the behavior from the screencast is unrelated to #2405Kazam_screencast_00003.mp4
License
Before opening the PR, please ensure you have completed the following where appropriate.