Sphinx中未解决的参考文献

时间:2012-12-10 22:08:39

标签: python python-sphinx restructuredtext

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

.. 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多个警告(对于整个项目)并不是那么好。

这些确切的例子当然是弥补的。我要求的是某种暗示,在哪里寻找答案。

1 个答案:

答案 0 :(得分:0)

我希望它能分开分开。目标是一方,另一方面定义:

.. exmpl:cfunction:: ExMplSet

ExMpl* ExMplSet( int flags, int size, ExStorage* storage )

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