可以从我的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。

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

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