In translated docs, sort glossaries by translated terms #10091
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
(CC @Fipaddict @JulienPalard.) |
|
Thanks for the review @tk0miya, I'll address your comments soon. Do you have an idea why the CI is failing? All GitHub seems to tell me is just "this check failed" for a bunch of jobs without a log; did I miss it somewhere? Tests pass locally for me. |
|
Oh, and the "Summaries" are “GitHub Actions has encountered an internal error when running your job.” |
|
Now I restarted CI jobs manually. I hope it goes well. |
This is done by moving the sorting from the glossary directive to a transform operating after the i18n transform. Closes sphinx-doc#9827
jeanas
force-pushed
the
sorted-glossary
branch
from
9714677
to
0269bec
Compare
|
Yes, it went a lot better. I've pushed an update addressing your comments and fixing flake8 as well as mypy checks. |
tk0miya
approved these changes
Jan 12, 2022
|
Thank you for your quick update! I'll merge this after CI passed. |
|
Thank you for your contribution! |
|
Thanks a lot for the review! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is done by moving the sorting from the glossary directive to a
transform operating after the i18n transform.
Closes #9827
Feature or Bugfix
Purpose
Translated glossaries were sorted according to alphabetical order of English terms, which makes no sense to a reader of the native language. An example can be found here: https://docs.python.org/fr/3/glossary.html. This sorts them according to translated terms instead. To this end, the glossary directive no longer sorts the entries itself. Instead, it sets a boolean attribute on the glossary node, and a transform happening after the i18n transform takes care of sorting glossaries with this attribute.
This is my first contribution to Sphinx and I'm still new to the code; please let me know if I've missed something.
Relates
#9827