readthedocs/sphinx_rtd_theme

breadcrumbs_aside should not contain github links for generated files

Open

#765 aperta il 24 mag 2019

Vedi su GitHub
 (3 commenti) (2 reazioni) (0 assegnatari)CSS (1413 fork)batch import
AcceptedBugGood First Issue

Metriche repository

Star
 (3473 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Il problema è che il blocco 'breadcrumbs aside' nel tema Sphinx RTD include i link 'Edit on GitHub' su pagine generate come 'search' e 'genindex', che non esistono nel repository git. La soluzione proposta aggiunge una condizione per escludere quei nomi di pagina. Un contributore dovrebbe modificare il template breadcrumbs.html per aggiungere la condizione `if hasdoc(pagename) and pagename != "search" and pagename != "genindex"` prima di mostrare il link. La correzione è localizzata e ben documentata nell'issue.
Tech stack
pythonhtml
Dominio
documentation
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80