Fix "More" links in mobile sidebar

[gabalafou]

Fixes #1603.

[gabalafou]

I'm not entirely sure why this works, but it does.

Is there a way to pass a variable through to the template when it's rendered? The navbar_nav template is used both in the sidebar and in the header, but I'm not sure how to let the navbar_nav template know when it's being called by the sidebar or by the header. If we can do that, then we could output different markup in the sidebar than in the header. That would be another way to fix the bug.

[trallard]

I checked preview in https://pydata-sphinx-theme--1604.org.readthedocs.build/en/1604/ and it works 🎉

As per

Is there a way to pass a variable through to the template when it's rendered? The navbar_nav template is used both in the sidebar and in the header, but I'm not sure how to let the navbar_nav template know when it's being called by the sidebar or by the header. If we can do that, then we could output different markup in the sidebar than in the header. That would be another way to fix the bug.

I really do not know if this is possible - so will let other folks chime in otherwise this seems like a fix that works and could be merged

[drammock]

Is there a way to pass a variable through to the template when it's rendered?

Jinja templates have access to a context (variables and functions Jinja can "see" when rendering the content in the template). This sphinx page lists everything that sphinx itself provides to the context. Also available are all variables in our theme.conf (possibly with values overridden in the user's conf.py) and all the values from the user's html_context dict.

You can also define variables within Jinja using {% set var="value" %} but it's important to note that Jinja restricts variable scope to the block level, so here:

{% block sidebar %}
  <div class="sidebar">
    {% block page_toc %}
      {% set whatever="foo" %}
      <div class="toc">...</div>
    {% endblock %}
    {% if whatever == "foo" %}
      <!-- do something -->
    {% endif %}
  </div>
{% endblock %}

the if clause will actually fail because whatever won't be available outside the page_toc block. You can work around this a little bit by using Jinja namespace variables (see also scoping behavior) but even that has some limitations (so far the ones I've hit relate to overriding only certain blocks in inherited templates, where the namespace was declared in the parent template and I'm trying to modify one of its attributes in the child template --- apparently Jinja renders the child template without the context of the parent template so the namespace isn't available to be modified)

[drammock]

If I'm understanding correctly, this is adding class show to every element that gets a pst-nav-more-links* ID. So why not just insert class show here, and dispense with the javascript?

pydata-sphinx-theme/src/pydata_sphinx_theme/toctree.py

Line 220 in fcde006

<ul id="{dropdown_id}" class="dropdown-menu">

[drammock]

If I'm understanding correctly

argh, never mind, I'm not understanding correctly.

[drammock]

I played around a bit to see if it was indeed possible to do this in the templates instead of in JS. It is possible, but it's messy and created other problems (the dropdown items ended up indented and the "more" title wasn't hidden) so let's just go with what works.

(@gabalafou FWIW, what sort-of worked was adding a new param extra_classes=[] to the generate_header_nav_html function (and incorporating any extra classes into the UL tag), doing {% set extra_classes = ["show"] %} within layout.html in the relevant spot, and then in navbar-nav.html adding a conditional {% if extra_classes is defined %} and if so calling generate_header_nav_html with that extra parameter.)