为什么我无法获得在 Sphinx 中工作的参考资料？

Question

我已尝试参考其他文档，但无法 ref 正常工作。它甚至不能在同一个文档中工作！

这是我的例子：

:ref:'my-reference-label'

Answer 1

经过数小时的谷歌搜索并最终复制粘贴了一些有效的 Sphinx 标记后，我发现这完全是一个拼写错误。我在写这个：

:ref:'my-reference-label'

我应该写的时候：

:ref:`my-reference-label`

是的，那是一个反引号。在屏幕上它看起来非常像一个单引号，如果您急于浏览 Sphinx 文档以便真正开始完成一些工作，您可能会错过这个小事实。

哦，Sphinx 文档也没有提到“反引号”这个词，一次也没有。所以如果你自己没有发现这个，那就太糟糕了。

请问我可以恢复三个小时的生活吗？