Skip to content

Build: highlight the name of the version #625

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 5 commits into
base: main
Choose a base branch
from
Open

Build: highlight the name of the version #625

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
15a1700
Build: highlight the name of the version
humitos Jul 8, 2025
84c4f4e
Lint and format
humitos Jul 8, 2025
c5f7a61
Feedback
humitos Jul 9, 2025
af60ab6
Link breadcrums properly
humitos Jul 9, 2025
2cdfa7f
Updates for `page_title`
humitos Jul 9, 2025
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
75 changes: 42 additions & 33 deletions readthedocsext/theme/templates/builds/includes/build_name.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,51 +33,60 @@

{% endcomment %}

{% load i18n %}
{% load trans blocktrans from i18n %}

{# When not a page title, treat the entire breadcrumb as a link to the build #}
{% if not is_page_title %}<a href="{{ build.get_absolute_url }}">{% endif %}
<span class="ui {% if is_page_title %}large{% endif %} breadcrumb">
<span class="section">
<span class="ui {% if is_page_title %}large{% endif %} breadcrumb">
<span class="section">
{# When used a a page title, link the sections independently #}
{% if is_page_title %}
<a href="{% url "projects_detail" build.project.slug %}?slug={{ build.get_version_slug }}">
{% endif %}
{# Translators: this renders with the version name, example "Version latest" #}
{% if is_page_title %}
<a href="{% url "projects_detail" build.project.slug %}">
{% endif %}
{% blocktrans trimmed %}
Versions
{% endblocktrans %}
{% if is_page_title %}</a>{% endif %}
</span>

{% if build.is_external %}
{{ build.external_version_name | lower | capfirst }}
{{ build.get_version_name }}
<span class="section">
<span class="divider">/</span>
Comment on lines +54 to +55
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ordering is off here, see https://fomantic-ui.com/collections/breadcrumb.html

Suggested change
<span class="section">
<span class="divider">/</span>
<span class="divider">/</span>
<span class="section">

{% if is_page_title %}
<a href="{% url "projects_detail" build.project.slug %}?slug={{ build.get_version_slug }}">
{% endif %}
{{ build.external_version_name | lower | capfirst }}
{{ build.get_version_name }}
{% if is_page_title %}</a>{% endif %}
</span>
{% else %}
{# Translators: this renders with the version name, example "Version latest" #}
{% blocktrans trimmed with version_name=build.get_version_name %}
Version {{ version_name }}
{% endblocktrans %}
<span class="section">
<span class="divider">/</span>
Comment on lines +64 to +65
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<span class="section">
<span class="divider">/</span>
<span class="divider">/</span>
<span class="section">

{% if is_page_title %}
<a href="{% url "projects_detail" build.project.slug %}?slug={{ build.get_version_slug }}">
{% endif %}

{{ build.get_version_name }}

{% if is_page_title %}</a>{% endif %}
</span>
{% endif %}

{% if is_page_title %}
{# When used as a page title, show a section link for the filtered build list #}
<span class="divider">/</span>
{# Translators: this refers to a list of builds for a single project #}
<a class="section"
href="{% url "builds_project_list" build.project.slug %}?version__slug={{ build.get_version_slug }}">
{% trans "Builds" %}
</a>
{% endif %}
</span>
{% if is_page_title %}
{# When used as a page title, show a section link for the filtered build list #}
<span class="divider">/</span>
{# Translators: this refers to a list of builds for a single project #}
<a class="section" href="{% url "builds_project_list" build.project.slug %}?version__slug={{ build.get_version_slug }}">
{% trans "Builds" %}
</a>
{% endif %}
<span class="divider">/</span>
<span class="active section">
{% if is_page_title %}
<a href="{{ build.get_absolute_url }}">
{% endif %}
<span class="ui grey text">
#{{ build.pk }}
<span class="active section">
{% if is_page_title %}<a href="{{ build.get_absolute_url }}">{% endif %}
<span class="ui grey text">#{{ build.pk }}</span>
{% if is_page_title %}</a>{% endif %}
Comment on lines +87 to +89
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

djlint isn't picking up on the conditional start/end tags and is breaking indenting. I believe in other templates we use {# fmt:off #}/fmt:on comments around these conditionals to fix this.

</span>
{% if is_page_title %}
</a>
{% endif %}
</span>
</span>
</a>
{% if not is_page_title %}</a>{% endif %}
{% if not is_page_title %}</a>{% endif %}