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

Support case insensitive 'term' for glossary references #7636

Closed
ideasman42 opened this issue May 9, 2020 · 5 comments
Closed

Support case insensitive 'term' for glossary references #7636

ideasman42 opened this issue May 9, 2020 · 5 comments

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
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
@tk0miya
Copy link
Member

tk0miya commented May 9, 2020

Please set suppress_warnings = ['ref.term']. Then warnings will be suppressed.
Thanks,

@tk0miya tk0miya closed this as completed May 9, 2020
@tk0miya tk0miya added type:question and removed type:enhancement enhance or introduce a new feature labels May 9, 2020
@ideasman42
Copy link
Contributor Author

ideasman42 commented May 9, 2020

This suppresses all ref.term warnings including invalid references that don't exist, which I don't want to suppress.

@polyvertex
Copy link

polyvertex commented Nov 8, 2020

@tk0miya would it be reasonable to have at least an option added to the glossary directive?

Something like the following:

.. glossary::
    :caseinsensitive:

    [...]

@ideasman42
Copy link
Contributor Author

@polyvertex that would be fine.

@tk0miya
Copy link
Member

tk0miya commented Dec 11, 2020

@polyvertex I need to know how to implement the option. I can accept your idea if a good PR is submitted.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 17, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants