如何在 Sphinx 文档集中的页面之间 link

Question

我在谷歌上搜索了很多次都找不到答案。

我第一次涉足 sphinx，但我看不出如何将 links 包含到我的 sphinx 文档中的另一个页面。 :doc 指令似乎可以解决问题，但它不起作用。

例如，假设我有一棵非常简单的树：

./index.rst
./files/CPPFiles.rst
./files/PythonFiles.rst

第一个 index.rst 以及有一个目录想要 link 到 "free" 文本中的这些子文件之一，所以我的 index.rst 包含这个:

My Docs
=======

This is a Python module but powered by a C++ back end. 
Unless you're planning on extending this module you only need
to read :doc:`the Python docs<files/PythonFiles>`.


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   files/PythonFiles
   files/CPPFiles

我也试过

:doc`files/PythonFiles`

在这两种情况下，:doc: 中的文本都按预期显示，但不是 link。

Answer 1

白色 space 在 reStructuredText 中有意义。

:doc:`the Python docs<files/PythonFiles>`.

应该是：

:doc:`the Python docs <files/PythonFiles>`.

如何在 Sphinx 文档集中的页面之间 link

How to link between pages in a Sphinx doc set

cross-reference

python-sphinx