Allow selectively suppressing warnings

[shimizukawa]

Hello,

When using markup like :envvar:, I often do not have a corresponding reference target (e.g. when referring to LD_CONFIG or PATH). This leaves me with the choice of either getting a spurious warning during build, or not tagging these variables correctly.

It would be great if Sphinx would allow me to selectively suppress such warnings. I imagine the least intrusive change would be to just introduce a list of "known missing" targets in conf.py. If a target is missing, sphinx would check this list and only issue a warning if the target is not in there.

---

• Bitbucket: https://bitbucket.org/birkenfeld/sphinx/issue/1345
• Originally reported by: Nikolaus Rath
• Originally created at: 2014-01-12T20:12:52.846

[shimizukawa]

From Georg Brandl on 2014-01-12 19:22:36+00:00

A "known missing" config value seems easy to do and reasonable.

[shimizukawa]

From Georg Brandl on 2014-01-12 19:30:59+00:00

Actually, there is already the nitpick_ignore list. Does that do what you want?

[shimizukawa]

From Georg Brandl on 2014-01-12 19:43:33+00:00

I think it should do, with two little fixes I'll do shortly:

• when changing nitpick_ignore, you had to do "make clean" before Sphinx gets the new value, with the fix it works with normal incremental rebuild.
• for "std" domain roles you would have to use an entry like ('std:envvar', 'LD_CONFIG'); with the fix you can also use ('envvar', 'LD_CONFIG').

[shimizukawa]

From Nikolaus Rath on 2014-01-12 19:59:52+00:00

Awesome, thanks a lot! I actually didn't know about nitpick_ignore.

[shimizukawa]

From Georg Brandl on 2014-01-12 20:09:21+00:00

I've made it a little more conspicuous now by mentioning it where the -n command line switch is documented, and I've pushed the fixes I spoke of in c66d03eed714. My pleasure :)