readthedocs/sphinx_rtd_theme

breadcrumbs_aside should not contain github links for generated files

Open

#765 ouverte le 24 mai 2019

Voir sur GitHub
 (3 commentaires) (2 réactions) (0 assignés)CSS (1 413 forks)batch import
AcceptedBugGood First Issue

Métriques du dépôt

Stars
 (3 473 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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

Guide contributeur

Direction de recherche
Le problème est que le bloc 'breadcrumbs aside' dans le thème Sphinx RTD inclut des liens 'Edit on GitHub' sur des pages générées comme 'search' et 'genindex', qui n'existent pas dans le dépôt git. La correction proposée ajoute une condition pour exclure ces noms de page. Un contributeur doit modifier le modèle breadcrumbs.html pour ajouter la condition `if hasdoc(pagename) and pagename != "search" and pagename != "genindex"` avant d'afficher le lien. La correction est localisée et bien documentée dans l'issue.
Stack technique
pythonhtml
Domaine
documentation
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80