在不将 headers 更改为链接的情况下包含内容指令
Include contents directive without changing headers to links
如果我在文档中包含 .. contents::
指令,页面上的所有标题都将 link 指向页面锚点 #id1
、#id2
...
没有 .. contents::
,页面上的 headers 不是 link(但悬停时会显示锚点 link)。是否可以在不将页面标题更改为 links 的情况下包含内容?
.. contents:: Table of Contents
#############
Heading 1
#############
*************
Heading 2
*************
contents
directive 接受几个选项,其中之一是 backlinks
。它的默认值是 entry
,它会将每个标题的 link 加回其在内容 table 中的相应条目。这是您观察到的行为。使用 top
,它会 link 回到整个内容的 table。如果将值设置为 none
,back-links 将被删除。
.. contents:: Table of Contents
:backlinks: none
#############
Heading 1
#############
*************
Heading 2
*************
这是 rst.ninjs.org 提供的 live rendering,您 link 访问的同一站点。请注意,它使用 Docutils 呈现 reStructuredText 输入。悬停时显示的 link 部分由 Sphinx 添加。至少在默认情况下。您也可以通过在 Sphinx 的配置文件 conf.py
.
中设置 html_permalinks = False
来抑制它们
如果我在文档中包含 .. contents::
指令,页面上的所有标题都将 link 指向页面锚点 #id1
、#id2
...
没有 .. contents::
,页面上的 headers 不是 link(但悬停时会显示锚点 link)。是否可以在不将页面标题更改为 links 的情况下包含内容?
.. contents:: Table of Contents
#############
Heading 1
#############
*************
Heading 2
*************
contents
directive 接受几个选项,其中之一是 backlinks
。它的默认值是 entry
,它会将每个标题的 link 加回其在内容 table 中的相应条目。这是您观察到的行为。使用 top
,它会 link 回到整个内容的 table。如果将值设置为 none
,back-links 将被删除。
.. contents:: Table of Contents
:backlinks: none
#############
Heading 1
#############
*************
Heading 2
*************
这是 rst.ninjs.org 提供的 live rendering,您 link 访问的同一站点。请注意,它使用 Docutils 呈现 reStructuredText 输入。悬停时显示的 link 部分由 Sphinx 添加。至少在默认情况下。您也可以通过在 Sphinx 的配置文件 conf.py
.
html_permalinks = False
来抑制它们