Skip to content

Respect html_show_sourcelink setting #1633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+13 −3
Open

Respect html_show_sourcelink setting #1633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions sphinx_rtd_theme/breadcrumbs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,18 @@
{%- set display_gitlab = True %}
{%- endif %}

{%- set display_vcs_links = display_vcs_links if display_vcs_links is defined else True %}
{%- set sourcelinks = True %}
{%- if html_show_sourcelink is false %}
{#- https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_show_sourcelink -#}
{%- set sourcelinks = False %}
{%- elif hasdoc(pagename) is false %}
{#- disable for autogenerated pages -#}
{%- set sourcelinks = False %}
{%- elif pagename == 'search' %}
{#- explicitly disable for search page -#}
{#- https://github.com/readthedocs/sphinx_rtd_theme/issues/934 -#}
{%- set sourcelinks = False %}
{%- endif %}

{#- Translators: This is an ARIA section label for page links, including previous/next page link and links to GitHub/GitLab/etc. -#}
<div role="navigation" aria-label="{{ _('Page navigation') }}">
Expand All @@ -30,7 +41,7 @@
{%- endblock %}
{%- block breadcrumbs_aside %}
<li class="wy-breadcrumbs-aside">
{%- if hasdoc(pagename) and display_vcs_links %}
{%- if sourcelinks %}
{%- if display_github %}
{%- if check_meta and 'github_url' in meta %}
<!-- User defined GitHub URL -->
Expand Down
1 change: 0 additions & 1 deletion sphinx_rtd_theme/search.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
#}
{%- extends "layout.html" %}
{% set title = _('Search') %}
{% set display_vcs_links = False %}
{%- block scripts %}
{{ super() }}
<script src="{{ pathto('_static/searchtools.js', 1) }}"></script>
Expand Down