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

问题描述 投票:0回答:1

很抱歉,这很容易,但是经过大量Google搜索后,我找不到答案。

[第一次进入狮身人面像,但我看不到如何在我的狮身人面像文档中包含指向另一个页面的链接。似乎:doc指令应该可以解决问题,但它不起作用。

例如,假设我有一棵非常简单的树:

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

第一个,index.rst以及拥有一个TOC都希望在“自由”文本中链接到这些子文件之一,因此我的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:中的文本均按预期显示,但不是链接。

我确定我在这里是个白痴,但是我找不到解决办法,所以如果有人能指出我的答案,我将非常感激!

python-sphinx cross-reference
1个回答
0
投票

空白在reStructuredText中具有含义。

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

应该是:

:doc:`the Python docs <files/PythonFiles>`.
© www.soinside.com 2019 - 2024. All rights reserved.