gh-138700: Add :sorted: option to automatically sort glossary#150321
Open
Vaibhav-S-Gowda wants to merge 1 commit into
Open
gh-138700: Add :sorted: option to automatically sort glossary#150321Vaibhav-S-Gowda wants to merge 1 commit into
Vaibhav-S-Gowda wants to merge 1 commit into
Conversation
|
All commit authors signed the Contributor License Agreement. |
Documentation build overview
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Pull Request title
gh-138700: Add :sorted: option to automatically sort glossary
Description
This PR adds the
:sorted:option to the.. glossary::directive block insideDoc/glossary.rst.Rationale
Currently, the Python documentation glossary is only organized in hardcoded alphabetical order for English. When the documentation is built for localized translations, the terms remain out of native alphabetical order for those target languages. Utilizing Sphinx's built-in
:sorted:flag ensures that all language translations automatically compile their localized glossaries in clean, native alphabetical ordering during the build process.Verification
make clean && make html) using a custom virtual environment... _glossary:) resolves perfectly and the build completes without errors.