编号参考sphinx中的数字

时间:2016-03-18 03:47:48

标签: python-sphinx

使用sphinx 1.3.6我发现无法对数字进行编号引用。 根据这里的答案和评论Referencing figures with numbers in Sphinx and reStructuredText numref是用sphinx构建的。但这根本不起作用

.. _mylabel

.. figure:: img/fig.jpg

   this is the caption

当我在文本中使用:numref:`Figure %s <mylabel>`时,结果实际上是Figure %s,就好像实际上没有实现numref一样。

我是否需要放入conf.py或乳胶序言中的内容?

2 个答案:

答案 0 :(得分:0)

我意识到这是一篇过时的文章,但是我想分享一下在这种情况下对我有帮助的事情。

以下代码将为图像添加编号的链接,并带有编号的标题。例如,链接Fig. 1将链接到标题为 Fig。的图像。 1系统处理流程

documentation.rst文件:

This is some boring documentation text which refers to the illustration in :numref:`my-image`.

.. figure:: images/process_flow.png
    :name: my-image
    :align: center
    :width: 100%

    System Process Flow

conf.py文件:

将此行添加到您的conf.py文件中:

numfig = True

您的Sphinx文档现在将具有指向您的数字的链接。

答案 1 :(得分:0)

另外,page.rst必须包含在某些“ toctree”中。

否则它将引发以下错误:

警告:未为图形分配编号