Python 如何在reStructuredText中添加指向其他页面的链接?
我正在使用Sphinx为我的项目创建文档,但我很难理解RST的基本概念 因此,我有一个带有Python 如何在reStructuredText中添加指向其他页面的链接?,python,python-sphinx,restructuredtext,Python,Python Sphinx,Restructuredtext,我正在使用Sphinx为我的项目创建文档,但我很难理解RST的基本概念 因此,我有一个带有index.rst的基本项目,我正在使用sphinx rtd主题来设计它。所以我创建了html,在左边我有一个菜单,就像。现在我为文档创建了一个新页面,rst文件名为auth.rst 我不明白的是,如何在左侧的侧菜单中添加指向其他页面的链接,例如auth.rst?现在,我在菜单上有两个链接:欢迎使用TestAPI的文档和索引和表格,如何向文档的其他页面添加新链接?我不明白在下面的代码中这是在哪里定义的,我没
index.rst
的基本项目,我正在使用sphinx rtd主题来设计它。所以我创建了html,在左边我有一个菜单,就像。现在我为文档创建了一个新页面,rst文件名为auth.rst
我不明白的是,如何在左侧的侧菜单中添加指向其他页面的链接,例如auth.rst
?现在,我在菜单上有两个链接:欢迎使用TestAPI的文档和索引和表格,如何向文档的其他页面添加新链接?我不明白在下面的代码中这是在哪里定义的,我没有找到太多关于这方面的信息
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