如何在 reStructuredText 中添加指向其他页面的链接?

问题描述

我正在使用 Sphinx 为我的项目创建文档,但我很难理解 RST 的基本概念。

所以我有一个带有 index.rst 的基本项目,我正在使用 sphinx-rtd-theme 来设置它的样式。所以我创建了 html,在左边我有一个菜单,就像 here。现在我为文档创建了一个页面,第一个文件名为 auth.rst

我不明白的是如何在左侧的侧边菜单添加指向其他页面链接,例如 auth.rst?现在,我在该菜单上有两个链接欢迎使用 Test-API 的文档!索引和表格,我如何添加指向文档其他页面的新链接?我不明白这在下面的代码中在哪里定义,我没有找到太多关于这个

Welcome to Test-API's documentation!
================================

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



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

解决方法

在 ':caption ...' 下,您将相对路径(从此 RST 文件在磁​​盘上的位置)写入目标 rst(在您的情况下为 auth.rst)

示例,给定此文件夹结构:

RST
  |- a.rst
  |- b.rst
  |-folder2 
    |-c.rst
    |-d.rst

在 a 中,如果我想引用 b 和 c,我可以:

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   b
   folder2/c

如果我想从 c 中引用 d,我会在 c 中这样做:

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