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

所以我正在为我的库编写PHP文档。我使用“sphinxcontrib.phpdomain”扩展名来支持PHP域。是否可以从我的PHP域名生成TOC树？

比方说，我已经定义了下列文件：

.. 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索引

来源

2017-09-09 Alexis Côté

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

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

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

来源

2017-09-09 17:58:27

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

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

回答

相关问题