readthedocs/sphinx_rtd_theme

breadcrumbs_aside should not contain github links for generated files

Open

#765 opened on May 24, 2019

View on GitHub
 (3 comments) (2 reactions) (0 assignees)CSS (3,473 stars) (1,413 forks)batch import
AcceptedBugGood First Issue

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

Contributor guide

Tech stack
htmlcsspython
Domain
frontenddocumentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Sphinx template familiaritybasic Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
The issue is that the 'breadcrumbs aside' block in the Sphinx RTD theme includes 'Edit on GitHub' links on generated pages like 'search' and 'genindex', which don't exist in the git repository. The proposed fix adds a condition to exclude those page names. A contributor should modify the breadcrumbs.html template to add the condition `if hasdoc(pagename) and pagename != "search" and pagename != "genindex"` before showing the link. The fix is localized and well documented in the issue.