Skip to content
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.

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

HTML: Assign glossary terms with grouping keys to single-character groupings #12862

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Commits on Sep 4, 2024

  1. Configuration menu
    Copy the full SHA
    ef7312b View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    1334038 View commit details
    Browse the repository at this point in the history
  3. Glossary: derive index group from category_key

    This fixes a bug where previously the `category_key` -- an optional
    grouping that can be specified on glossary terms -- was used directly
    as the group name to place terms within in the generated HTML index.
    
    The fix re-uses a similar logic flow as used in `_key_func_1`, where
    the `category_key` is used to derive (but not as an absolute source
    of) the index group.
    jayaddison committed Sep 4, 2024
    Configuration menu
    Copy the full SHA
    4255bbe View commit details
    Browse the repository at this point in the history
  4. Add CHANGES.rst entry

    jayaddison committed Sep 4, 2024
    Configuration menu
    Copy the full SHA
    51aec85 View commit details
    Browse the repository at this point in the history

Commits on Sep 5, 2024

  1. Glossary: nest category_key items in index

    The grouping key (`category_key`) from glossary terms is used to
    decide what symbol/character to group the corresponding terms into.
    
    However: the terms are not guaranteed to begin with the same symbol
    as the `category_key`.  This code therefore places them into a nested
    definition entry in the index, with the complete `category_key` as
    the parent label.
    
    Relates to commit 4255bbe.
    jayaddison committed Sep 5, 2024
    Configuration menu
    Copy the full SHA
    6a38601 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    295ee97 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    2233c16 View commit details
    Browse the repository at this point in the history