breadcrumbs_aside should not contain github links for generated files

[mquinson]

Problem

By default, my search and genindex pages contain a link "Edit on GitHub" but they naturally don't exist in the git. This should not be the case.

Reproducible Project

https://framagit.org/simgrid/simgrid/tree/master/docs/source Build logs are available from "pages" tasks on https://framagit.org/simgrid/simgrid/-/jobs But I have a local fix, so you won't see much in the logs ;)

Proposed fix

Here is my _templates/breadcrumbs.html file. This fixes the problem for me.

{%- extends "sphinx_rtd_theme/breadcrumbs.html" %}

{% block breadcrumbs_aside %}
  <li class="wy-breadcrumbs-aside">
    {% if hasdoc(pagename) and pagename != "search" and pagename != "genindex" %}
      <a href="{{ meta['framagit_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on FramaGit') }}</a>
    {% endif %}
  </li>
{% endblock %}

The important thing is pagename != "search" and pagename != "genindex" in the conditional.

Note that I also edit the link name because I'm not using the central gitlab instance.

Environment Info

My requirements.txt reads:

breathe
javasphinx
sphinx>=1.8.0
sphinx_rtd_theme

[stsewd]

I fixed the one from search in https://github.com/readthedocs/sphinx_rtd_theme/pull/935/ but looks like a regression happened and now it still displays the link (guessing this https://github.com/pallets/jinja/pull/994/).. .Looks like your solution is better anyway :) feel free to open a PR!

[stsewd]

also, I'd use pagename not in {'search', 'genindex'} instead of multiple "and"

[saraedum]

The search page does not have that link anymore actually. To also hide it on genindex I am using this in _templates/breadcrumbs.html.

{%- extends "sphinx_rtd_theme/breadcrumbs.html" %}

{% block breadcrumbs_aside %}
  {% if pagename not in ['genindex'] %}
    {{ super() }}
  {% endif %}
{% endblock %}