我在sphinx页面中有一个.. toctree
,其中包含指向我包中其他rst
文件的相对链接。如何在链接中包含到给定页面的子标题,而不是整个页面本身?
我试着去......
.. toctree::
page#section
但那没有起作用。任何帮助都很好。
我在sphinx页面中有一个.. toctree
,其中包含指向我包中其他rst
文件的相对链接。如何在链接中包含到给定页面的子标题,而不是整个页面本身?
我试着去......
.. toctree::
page#section
但那没有起作用。任何帮助都很好。
经过多次尝试,我找到了以下解决方案,但首先需要说明我的目标是:
因此,从目录链接到文档中任意但不可见的部分。
我需要这个功能来链接Sphinxcontrib PHPDomain生成的某些源代码文档中的方法 - 这些方法会自动生成自己的部分链接,但默认情况下不会添加到目录中。
步骤1:
在需要此链接功能的RST文件顶部添加一个新角色,如下所示:
.. role:: hidden
:class: hidden
:hidden:`My Arbitrary Location`
"""""""""""""""""""""""""""""""
第三步:
向项目添加新的CSS(通常通过将CSS文件添加到_static
中,或定义样式表等方式完成 - 参见此处):
.rst-content .hidden {
display: none;
}
nav .hidden {
display: unset;
}
这将导致标题在内容中被隐藏,但在TOC中显示。
然后,在其他文档中根据需要重复使用该角色。
请注意,如果您的目标是链接到文档中的任意位置并仍然在内容中显示标题,只需更改CSS以使标题按您的喜好进行样式设置,而不是隐藏它们。
.. _my-rst-file:
**You can use bold print here if you want. This will not appear in the ToC**
.. rubric:: Or the "rubric" directive
And here some more text, normal font weight.
Here comes the heading that will appear in the ToC
""""""""""""""""""""""""""""""""""""""""""""""""""
And so on...
您需要像往常一样在目录中包含页面引用。 因此,在目录中,您应该有:
.. toctree::
my_rst_file
你好世界 <my_rst_file>
- Blundell