在toctree中添加self的各个部分

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

我在获取目录(TOC)以显示文档首页的小节时遇到问题。

我的首页上有很多部分,希望将这些部分显示在目录中。该小节的显示对于目录中包含的所有其他页面均有效,但不适用于自身。

我的index.rst代码:

=====
Title
=====

Subsection
----------

Some documentation.

Contents
--------

.. toctree::
   :maxdepth: 2

   self
   development

我希望在目录中看到的是这个:

  • 标题
    • 小节
    • 目录
  • 发展
    • 小节

相反,我得到的是:

  • 标题
  • 发展
    • 小节

到目前为止,我已经找到了一种解决方案,但这并不完全令人满意。我可以将所有内容放在单独的页面中,然后使用index.rst指令将内容包括在.. include:中,然后将单独的页面放入目录中。这样可使目录看起来正确,但会创建一个重复页面,该页面现在已包含在导航中(上一页/下一页)。

python-sphinx restructuredtext sections toctree
1个回答
0
投票

您可以直接使用reStructuredText中的TOC指令:

.. contents::

请参见http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents

© www.soinside.com 2019 - 2024. All rights reserved.