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

REGR/DOC: Docs left navbar broke #48623

Merged
merged 4 commits into from Sep 18, 2022
Merged

REGR/DOC: Docs left navbar broke #48623

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
15c9167
REGR/DOC: Docs left navbar broke
rhshadrach Sep 18, 2022
8b4a8ce
Merge branch 'main' into sphinx_theme_regr
rhshadrach Sep 18, 2022
1bd6eb3
Restore file
rhshadrach Sep 18, 2022
9d13565
Merge branch 'sphinx_theme_regr' of https://github.com/rhshadrach/pan…
rhshadrach Sep 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/_templates/sidebar-nav-bs.html
View file
Open in desktop
@@ -1,5 +1,5 @@
<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">
Copy link
Member

Choose a reason for hiding this comment

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

Could you replace the class with bd-toc-item navbar-nav

This works locally and keeps the option to configure differently for different pages

Copy link
Member Author

Choose a reason for hiding this comment

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

@phofl - change made, can you double check it's correct? I'm now seeing no dropdowns on the API reference main page:

image

until I click into one

image

Collapsing it, I only get one dropdown

image

I haven't noticed any other changes from removing the file, and this behavior seems worse to me, but it is usable and happy to consider changing after the 1.5 release.

Copy link
Member

Choose a reason for hiding this comment

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

I am not sure what the impact of collapse=True/False is, so I am careful here.

The dropdown behaviour is consistent with our current docs (1.4.4 and also 1.3) so this should be ok for now I think?

Copy link
Member Author

Choose a reason for hiding this comment

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

I didn't realize that it is compatible with those previous docs. Sounds good.

<div class="bd-toc-item navbar-nav">
{% if pagename.startswith("reference") %}
{{ generate_toctree_html("sidebar", maxdepth=4, collapse=True, includehidden=True, titles_only=True) }}
{% else %}
Expand Down