Sphinx nit-picky模式，但仅适用于我明确编写的链接

Question

我曾尝试打开Sphinx的nit-picky模式（-n）来捕捉我可能不小心造成的任何断开的链接。但是，它会在我记录类型的所有地方喷出错误。在某些情况下，我已经在语义上描述了类型（例如“ 3D数组”），但即使是从类型提示中提取的类型，它也可以做到这一点（即使将intersphinx设置为提取Python类型）。例如，对于此模块

from typing import Callable

def foo(x: Callable[..., int]):
    pass

我收到错误docstring of myproj.foo:: WARNING: py:class reference target not found: Callable[..., int]。只有sphinx.ext.autodoc和sphinx.ext.intersphinx扩展名以及一个新生成的conf.py。

是否有某种方法可以防止Sphinx尝试为类型信息生成链接，或者至少在其不存在时阻止它抱怨，同时仍然在我的手写文档中告诉我有关错误链接的信息？

我正在使用Sphinx 3.0.3。

Answer 1

也许nitpick_ignore会做什么？在您的nitpick_ignore中，如下所示：

conf.py

我不确定应该使用的元组中的确切值，但是我从

nitpick_ignore = [
    ("py:class", "Callable"),
]

和this issue中得到了这个主意。