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

Option for case insensitive glossary references (without supressing all term warnings) #7642

Closed
ideasman42 opened this issue May 9, 2020 · 1 comment
Labels
domains:std type:enhancement enhance or introduce a new feature
Milestone

Comments

@ideasman42
Copy link
Contributor

Previously the glossary in sphinx was case insensitive, so foobar would properly link to Foobar in the glossary.
In sphinx-build 3.0.3 we're getting many warnings:

manual/addons/materials/material_library.rst:41: WARNING: term fake user not found in case sensitive match.made a reference to Fake User instead.
manual/animation/actions.rst:84: WARNING: term walk cycle not found in case sensitive match.made a reference to Walk Cycle instead.
manual/animation/armatures/bones/editing/bone_roll.rst:10: WARNING: term Euler rotation not found in case sensitive match.made a reference to Euler Rotation instead.
manual/animation/armatures/posing/bone_constraints/inverse_kinematics/spline_ik.rst:53: WARNING: term roll not found in case sensitive match.made a reference to Roll instead.
manual/animation/constraints/interface/common.rst:20: WARNING: term object origin not found in case sensitive match.made a reference to Object Origin instead.
manual/animation/constraints/interface/common.rst:22: WARNING: term mesh not found in case sensitive match.made a reference to Mesh instead.
manual/animation/constraints/interface/common.rst:22: WARNING: term lattice not found in case sensitive match.made a reference to Lattice instead.
manual/animation/constraints/interface/common.rst:34: WARNING: term head not found in case sensitive match.made a reference to Head instead.
manual/animation/constraints/interface/common.rst:34: WARNING: term tail not found in case sensitive match.made a reference to Tail instead.
manual/compositing/types/color/z_combine.rst:39: WARNING: term Anti-Aliasing not found in case sensitive match.made a reference to Anti-aliasing instead.
... snip ... (over 100 of these)

Describe the solution you'd like
An option to use case insensitive references without warning.

Describe alternatives you've considered

  • suppress_warnings = ["ref.term"] this suppresses all warnings, including references to non-existent glossary references (making this an impractical option).
  • Adding different cases to the glossary, however this adds quite a bit
    of redundancy with no real benefit.

Additional context

The current glossary we're maintaining https://docs.blender.org/manual/en/dev/glossary/index.html

@ideasman42 ideasman42 added the type:enhancement enhance or introduce a new feature label May 9, 2020
@ideasman42 ideasman42 changed the title <short description for the feature> Option for case insensitive glossary references (without supressing all term warnings) May 9, 2020
@tk0miya tk0miya added this to the 3.5.0 milestone Jan 23, 2021
tk0miya added a commit to tk0miya/sphinx that referenced this issue Jan 23, 2021
… term

Since 3.0.1, the term role has matched to the words in glossary
case-sensitively.  It's important change for preventing conflicts by
word cases.  But, it also brings a problem for references in natural
text.

This optimizes the case-insensitive match of the term role.  It allows
to search glossary words twice with no performance penalty; the first
search is case sensitive and another is case insenstive.
tk0miya added a commit to tk0miya/sphinx that referenced this issue Jan 23, 2021
… term

Since 3.0.1, the term role has matched to the words in glossary
case-sensitively.  It's important change for preventing conflicts by
word cases.  But, it also brings a problem for references in natural
text.

This optimizes the case-insensitive match of the term role.  It allows
to search glossary words twice with no performance penalty; the first
search is case sensitive and another is case insenstive.
tk0miya added a commit that referenced this issue Jan 24, 2021
…match_of_term

Close #7642: std domain: Optimize case-insensitive match of term
@tk0miya
Copy link
Member

tk0miya commented Jan 24, 2021

Finally, I determined to support case insensitive search officially. So warnings will not be shown.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 14, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
domains:std type:enhancement enhance or introduce a new feature
Projects
None yet
Development

No branches or pull requests

2 participants