代码之家 › 专栏 › 技术社区 › vinni

不同主题的狮身人面像文献

read-the-docs documentation-generation python-sphinx documentation

0

vinni · 技术社区 · 7 年前

我试图在索引中构建一个仪表板,每个主题一个平铺。每个主题稍后都有自己的文件夹 source 有自己的md文件。

我希望每个主题都与其他主题断开连接。所以 previous 按钮不应转到其他主题。

结构应该是这样的: 首先是一个包含所有主题的概述,然后是一个子页面,每个主题有一个目录树,然后每个文档都有自己的普通视图。

有人知道我会怎么做吗?

.. toctree::
   :maxdepth: 1
   :name: mastertoc
   :caption: Example Files:
   :glob:

   introduction
   examples

.. toctree::
   :maxdepth: 1
   :name: Subject1
   :caption: Subject1:
   :glob:

   Subject1/*

.. toctree::
   :maxdepth: 1
   :name: Subject2
   :caption: Subject2:
   :glob:

   Subject2/*

1 回复 | 直到 7 年前

1

Steve Piercy 7 年前

如果我理解你的要求,你也希望每个主题都有一个索引页。我们在几个地方为金字塔做的,比如:

docs/index.rst

.. toctree::
   :maxdepth: 1
   :glob:

   api/index
   api/*

docs/api/index.rst

.. toctree::
   :maxdepth: 1
   :glob:

   *

这就是它的作用:

https://docs.pylonsproject.org/projects/pyramid/en/latest/#api-documentation

第一个链接指向:

https://docs.pylonsproject.org/projects/pyramid/en/latest/api/index.html