:data:`~package._module._DICT_NAME`
无效; _DICT_NAME
就像被引用一样呈现,但是没有超链接。与:obj:
相同。将其放入函数中不是可接受的解决方法。
要[渲染] _DICT_NAME
,您实际上需要将其包括在.rst
中(使用自动数据或自动成员),并且需要在索引中添加某种注释(因此可引用)。请记住,变量不能具有文档字符串,因此您需要在注释前使用#:
或在注释后立即使用"""
。
您的_DICT_NAME
也是一个私有变量,因此,如果您使用的是Sphinx Napoleon扩展名,则需要检查conf.py
设置以查看是否像napoleon_include_private_with_doc = True
一样包含了它。