使用Sphinx在不同的文件中引用等式

时间:2012-01-05 09:21:10

标签: math reference python-sphinx

我正在使用Shinx记录我的代码。在某些文件中,我有数学公式,并希望包含对它们的引用。在同一个文件中,这不是问题。使用:eq:'reference'

但是,如何从不同的文件交叉引用公式?在我的情况下,Sphinx无法找到参考。

1 个答案:

答案 0 :(得分:1)

根据Sphinx文档here,方程式交叉引用目前仅适用于同一文档。我建议提交一个错误/功能请求来改变它(假设已经没有)。

作为一种解决方法,您可以使用generic cross referencing syntax,方法是在您要引用的等式(在“其他”文件中)之前放置一个引用标签,如下所示:

.. _equation_in_other_file:

然后使用类似的东西:

:ref:` Link Title <equation_in_other_file>`

在“当前”文件中引用它。

(请注意,您需要提供明确的链接标题)

它不是那么优雅,但它应该完成工作。