Skip to content

fix: sort user languages by display name #13791

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

Merged
merged 4 commits into from
Oct 13, 2025
Merged

fix: sort user languages by display name #13791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ab9cfdf
refactor: language handling in versions.html
joshtrichards Oct 12, 2025
c40d359
refactor: drop lang template mod from Makefile
joshtrichards Oct 12, 2025
a8c75ce
refactor: Add language detection for HTML context
joshtrichards Oct 12, 2025
0046d8f
fix(languages): Fix list of mapped languages
nickvergessen Oct 13, 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
22 changes: 9 additions & 13 deletions user_manual/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS +=
Expand All @@ -8,12 +7,14 @@ PAPER =
BUILDDIR = _build

# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
LANGS = $(shell touch locale/en && ls locale | grep -v source && rm locale/en) # this trick to add en in the list of langs
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

# Dynamically build the list of language codes (including 'en')
LANGS = $(shell touch locale/en && ls locale | grep -v source && rm locale/en)

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext

Expand Down Expand Up @@ -48,12 +49,7 @@ clean:

html:
../build/change_file_extension.sh
make versions-template-all html-all merge-folders

versions-template-all: $(foreach lang, $(LANGS), add-lang-to-versions-template-$(lang))

add-lang-to-versions-template-%:
sed -i '/Here go the languages/i {% set available_languages = available_languages + ["$*"] %}' ./_templates/versions.html
make html-all merge-folders

html-all: $(foreach lang, $(LANGS), html-allow-warnings-lang-$(lang))

Expand Down Expand Up @@ -104,7 +100,7 @@ htmlhelp:
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
@echo "Build finished; now you can run \"qcollectiongenerator\" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OwncloudDocumentation.qhcp"
@echo "To view the help file:"
Expand Down
254 changes: 75 additions & 179 deletions user_manual/_templates/versions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,187 +1,83 @@
{% if READTHEDOCS %}
{# Add rst-badge after rst-versions for small badge style. #}
{# Add rst-badge after rst-versions for small badge style. #}
<!-- Here go the languages -->
{% set available_languages = available_languages|sort %}

{# Language code to name mapping #}
{% set language_names = {
'af': 'Afrikaans',
'ar': 'Arabic',
'br': 'Breton',
'ca': 'Catalan',
'cs': 'Czech',
'da': 'Danish',
'de': 'German',
'el': 'Greek',
'eo': 'Esperanto',
'es': 'Spanish',
'en': 'English',
'eu': 'Basque',
'fi_FI': 'Finnish',
'fr': 'French',
'hr': 'Croatian',
'hu_HU': 'Hungarian',
'ga': 'Irish',
'gl': 'Galician',
'id': 'Indonesian',
'it': 'Italian',
'ja_JP': 'Japanese',
'ko': 'Korean',
'mn': 'Mongolian',
'nb_NO': 'Norwegian (NB)',
'nl': 'Dutch',
'nn': 'Norwegian (NN)',
'pl': 'Polish',
'pt_PT': 'Portuguese',
'pt_BR': 'Portuguese (BR)',
'ro': 'Romanian',
'ru': 'Russian',
'si': 'Sinhala',
'sk_SK': 'Slovakian',
'sq': 'Albanian',
'sr': 'Slovenian',
'sv': 'Swedish',
'ta': 'Tamil',
'tr': 'Turkish',
'uk_UA': 'Ukrainian',
'uz': 'Uzbek',
'vi': 'Vietnamese',
'zh_CN': 'Chinese',
'zh_HK': 'Chinese (HK)',
'zh_TW': 'Chinese (TW)'
} %}

{# Build list of {code, name} pairs for available languages #}
{% set language_tuples = [] %}
{% for code in available_languages %}
{% set _ = language_tuples.append({'code': code, 'name': language_names.get(code, code)}) %}
{% endfor %}
{% set sorted_languages = language_tuples | sort(attribute='name') %}

<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
🌐
{% set language_code = language %}
{% if language_code == 'cs' %}
Czech
{% elif language_code == 'da' %}
Danish
{% elif language_code == 'de' %}
German
{% elif language_code == 'el' %}
Greek
{% elif language_code == 'es' %}
Spanish
{% elif language_code == 'en' %}
English
{% elif language_code == 'fi_FI' %}
Finnish
{% elif language_code == 'fr' %}
French
{% elif language_code == 'hr' %}
Croatian
{% elif language_code == 'hu_HU' %}
Hungarian
{% elif language_code == 'id' %}
Indonesian
{% elif language_code == 'it' %}
Italian
{% elif language_code == 'ja_JP' %}
Japanese
{% elif language_code == 'ko' %}
Korean
{% elif language_code == 'mn' %}
Mongolian
{% elif language_code == 'nb_NO' %}
Norwegian
{% elif language_code == 'nl' %}
Dutch
{% elif language_code == 'pl' %}
Polish
{% elif language_code == 'pt_PT' %}
Portuguese
{% elif language_code == 'pt_BR' %}
Portuguese (BR)
{% elif language_code == 'ro' %}
Romanian
{% elif language_code == 'ru' %}
Russian
{% elif language_code == 'sk_SK' %}
Slovakian
{% elif language_code == 'sq' %}
Albanian
{% elif language_code == 'sr' %}
Slovenian
{% elif language_code == 'sv' %}
Swedish
{% elif language_code == 'tr' %}
Turkish
{% elif language_code == 'uk' %}
Ukrainian
{% elif language_code == 'uz' %}
Uzbek
{% elif language_code == 'vi' %}
Vietnamese
{% elif language_code == 'zh_CN' %}
Chinese
{% elif language_code == 'zh_HK' %}
Chinese (HK)
{% elif language_code == 'zh_TW' %}
Chinese (TW)
{% else %}
{{ language_code }}
{% endif %}
🌐 {{ language_names.get(language, language) }}
<span class="fa fa-caret-down"></span>

 ☁️ {{ current_version }}
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>🌐 {{ _('Languages') }}</dt>
{% for language_code in available_languages %}
<dd style="width: 32%; vertical-align: top;">
<a href="/server/latest/user_manual/{{ language_code }}/"
{% if language_code == language %}
style="color: var(--dark-link-color);"
{% endif %}
>
{% if language_code == 'af' %}
Afrikaans
{% elif language_code == 'ar' %}
Arabic
{% elif language_code == 'br' %}
Breton
{% elif language_code == 'ca' %}
Catalan
{% elif language_code == 'cs' %}
Czech
{% elif language_code == 'da' %}
Danish
{% elif language_code == 'de' %}
German
{% elif language_code == 'el' %}
Greek
{% elif language_code == 'eo' %}
Esperanto
{% elif language_code == 'es' %}
Spanish
{% elif language_code == 'en' %}
English
{% elif language_code == 'fi_FI' %}
Finnish
{% elif language_code == 'fr' %}
French
{% elif language_code == 'hr' %}
Croatian
{% elif language_code == 'hu_HU' %}
Hungarian
{% elif language_code == 'ga' %}
Irish
{% elif language_code == 'gl' %}
Galician
{% elif language_code == 'id' %}
Indonesian
{% elif language_code == 'it' %}
Italian
{% elif language_code == 'ja_JP' %}
Japanese
{% elif language_code == 'ko' %}
Korean
{% elif language_code == 'mn' %}
Mongolian
{% elif language_code == 'nb_NO' %}
Norwegian (NB)
{% elif language_code == 'nl' %}
Dutch
{% elif language_code == 'nn' %}
Norwegian (NN)
{% elif language_code == 'pl' %}
Polish
{% elif language_code == 'pt_PT' %}
Portuguese
{% elif language_code == 'pt_BR' %}
Portuguese (BR)
{% elif language_code == 'ro' %}
Romanian
{% elif language_code == 'ru' %}
Russian
{% elif language_code == 'si' %}
Sinhala
{% elif language_code == 'sk_SK' %}
Slovakian
{% elif language_code == 'sq' %}
Albanian
{% elif language_code == 'sr' %}
Slovenian
{% elif language_code == 'sv' %}
Swedish
{% elif language_code == 'ta' %}
Tamil
{% elif language_code == 'tr' %}
Turkish
{% elif language_code == 'uk' %}
Ukrainian
{% elif language_code == 'uz' %}
Uzbek
{% elif language_code == 'vi' %}
Vietnamese
{% elif language_code == 'zh_CN' %}
Chinese
{% elif language_code == 'zh_HK' %}
Chinese (HK)
{% elif language_code == 'zh_TW' %}
Chinese (TW)
{% else %}
{{ language_code }}
{% endif %}
</a>
</dd>
{% endfor %}
{% for lang in sorted_languages %}
<dd style="width: 32%; vertical-align: top;">
<a href="/server/latest/user_manual/{{ lang.code }}/"
{% if lang.code == language %}
style="color: var(--dark-link-color);"
{% endif %}
>
{{ lang.name }}
</a>
</dd>
{% endfor %}
</dl>
</div>
<div class="rst-other-versions">
Expand All @@ -208,12 +104,12 @@
<dl>
{# Translators: The phrase "Read the Docs" is not translated #}
<dt>{{ _('On Read the Docs') }}</dt>
<dd>
<a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">{{ _('Project Home') }}</a>
</dd>
<dd>
<a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">{{ _('Builds') }}</a>
</dd>
<dd>
<a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">{{ _('Project Home') }}</a>
</dd>
<dd>
<a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">{{ _('Builds') }}</a>
</dd>
</dl>
</div>
</div>
Expand Down
17 changes: 14 additions & 3 deletions user_manual/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@
'_templates',
]


exclude_patterns = [
'_build',
]
Expand Down Expand Up @@ -91,7 +90,6 @@
# -- Options for LaTeX output ------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-latex-output


latex_elements = {
}
latex_documents = [
Expand Down Expand Up @@ -154,6 +152,19 @@
current_docs = 'user_manual'
html_context['versions'] = generateVersionsDocs(current_docs)
html_context['theme_vcs_pageview_mode'] += current_docs
html_context['available_languages'] = [

# Automatically detect available languages and pass to template

locale_path = os.path.join(os.path.dirname(__file__), 'locale')
available_languages = []

if os.path.isdir(locale_path):
available_languages = [
lang for lang in os.listdir(locale_path)
if os.path.isdir(os.path.join(locale_path, lang)) and lang != 'source'
]
if 'en' not in available_languages:
available_languages.append('en')
available_languages.sort()

html_context['available_languages'] = available_languages
26 changes: 0 additions & 26 deletions user_manual/locale/eu/LC_MESSAGES/contents.pot
View file
Open in desktop

This file was deleted.

Loading