Skip to main content
 首页 » 编程设计

python之Sphinx 中 Unresolved 引用

2025年05月04日7findumars

假设我有一个项目,其中(某处)记录了以下功能:

.. exmpl:cfunction:: ExMpl* ExMplSet( int flags, int size, ExStorage* storage ) 

在该项目文档的其他地方我们有一个引用,看起来像这样:

:exmpl:cfunc:`ExMplSet` 

一切看起来都是合法的,文档中还有其他这种用法的例子,但输出 Sphinx 给出了警告:

~/some_folder/some_file:320: WARNING: unresolved reference: u'ExMplSet' - u'cfunc' 

没有应有的链接,而且 100 多个警告(针对整个项目)并不是那么好。

这些确切的例子当然是虚构的。我要的是某种提示,到哪里寻找答案。

请您参考如下方法:

我希望它被分成不同的行。一个目标,另一个定义:

.. exmpl:cfunction:: ExMplSet 
 
ExMpl* ExMplSet( int flags, int size, ExStorage* storage ) 

另一个选项(我现在无法检查)是您在“exmpl:”前面缺少一个冒号