为什么我不能参考Sphinx的工作?

时间:2015-09-29 09:12:00

标签: python-sphinx

我试图引用其他文档,但我无法让ref工作。它甚至不在同一个文档中工作!

这是我的例子:

:ref:'my-reference-label'

1 个答案:

答案 0 :(得分:0)

经过几个小时的谷歌搜索并最终复制粘贴一些有效的Sphinx标记,我发现这一切都是一个错字。我在写这个:

:ref:'my-reference-label'

当我应该写作时:

:ref:`my-reference-label`

是的,那是一个反击。在屏幕上它看起来非常像一个单引号,如果你正在匆匆通过Sphinx文档,所以你实际上可以开始完成一些工作,你可能会错过这个微小的事实。

哦,而且Sphinx文档中也没有提到“反引号”这个词,甚至没有提到过一次。所以,如果你没有自己发现这一点,那么太糟糕了。

我可以回来三个小时吗?