是否可以从我的 PHP 域生成 TOC 树？答案

【问题标题】：Is it possible to generate a TOC tree from my PHP domain?是否可以从我的 PHP 域生成 TOC 树？
【发布时间】：2018-02-18 07:25:55
【问题描述】：

所以我正在为我的库编写 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 树？例如，我想在树中索引类名和类成员。

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

【问题讨论】：

标签： php python-sphinx restructuredtext documentation-generation toctree

【解决方案1】：

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

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

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

【讨论】：

我发现的唯一一个 PHP autodoc 包已经过时了。出于这个原因，我决定手动编写文档。我找到了一种临时方法来索引我的类和方法。我直接做了一个自定义来定义隐藏的标题。这些标题隐藏在页面中，但它们显示在目录树中。