php - 是否可以从我的 PHP 域生成 TOC 树？

Question

所以我正在为我的库编写 PHP 文档。我正在使用“sphinxcontrib.phpdomain”扩展来支持 PHP 域。

假设我定义了以下文档：

.. toctree::
    :numbered:
    :maxdepth: 3
    :caption: Couch

.. php:class:: Couch

    This is the low-level class that handles communications with CouchDB.

    .. php:method:: dsn()

        :returns: The dsn of the current Couch instance

是否可以由此生成 TOC 树？例如，我想在树中索引类名和类成员。

目前，只有自定义标题在目录树中被索引

Answer 1

将您的 reStructuredText 示例拆分为两个文件。该toctree指令应该在index.rst您的文档文件中，并且该php:class指令应该在一个单独的文件中。明智的做法是根据类的名称来命名这样的文件，例如couch.rst. 这至少会为您提供顶级 TOC。

我不知道sphinxcontrib.phpdomain除了文件中的简单 reStructuredText 文件名和标题之外是否支持 TOC 条目。假设sphinxcontrib.phpdomain没有提供您想要的 TOC 深度，您可以尝试插入任意标题。

在 Python 中，我们可以autodoc自动记录 Python 代码，但我不知道它是否适用于 PHP 代码。否则，可能会有一些 PHP 包和autodocPython 一样。