是否可以从我的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树？例如，我想在树中索引类名和类成员。

目前，只有自定义标题会在toctree

中编入索引

Answer 1

将reStructuredText示例拆分为两个文件。 toctree指令应位于文档的index.rst文件中，php:class指令应位于单独的文件中。根据类的名称命名这样的文件是明智的，例如couch.rst。这至少会给你最高级别的TOC。

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

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