Sphinx文档具有不同的主题

时间:2018-08-21 13:59:39

标签: documentation python-sphinx documentation-generation read-the-docs

我正在尝试在索引中构建一种仪表板,每个主题一个图块。每个主题稍后都会在source中拥有自己的文件夹,并带有自己的md文件。

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

结构应如下所示: enter image description here 首先是所有主题的概述,然后是一个子页面,每个主题都有一个toctree,然后每个文档都有其自己的普通视图。

有人知道我会怎么做吗?

当前,我以这种方式建立索引,但这不会分隔文件:

.. 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 个答案:

答案 0 :(得分:1)

如果我理解您的要求,那么您也希望每个主题都有一个索引页面。我们在几个地方为金字塔做这些,就像这样:

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