PHPドメインからTOCツリーを生成することはできますか？

Question

私は私のライブラリのためのPHPドキュメントを書いています。 私はPHPドメインをサポートするために "sphinxcontrib.phpdomain"拡張子を使用しています。

はのは、私は次のドキュメントを定義したとしましょう：

.. 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からツリーを生成することは可能ですか？たとえば、ツリー内でクラス名とクラスメンバーを索引付けしたいとします。瞬間のために

は、唯一のカスタムタイトルは、2つのファイルに

Answer 1

スプリットあなたのreStructuredTextの例toctreeにインデックス化されています。 toctreeディレクティブは、ご使用のドキュメントのindex.rstファイルにあり、php:classディレクティブは別のファイルに入れる必要があります。そのようなファイルの名前をクラスの名前（例えば、couch.rst）にすることが賢明でしょう。それは少なくともあなたにトップレベルのTOCを与えます。

sphinxcontrib.phpdomainは、単純なreStructuredTextファイル名とファイル内の見出し以外のTOCエントリをサポートしているかどうかわかりません。 sphinxcontrib.phpdomainが必要なTOC深さを提供しないと仮定すると、任意の見出しを挿入することができます。

Pythonでは、autodocが自動的にPythonコードを文書化していますが、PHPコードで動作するかどうかはわかりません。さもなければ、autodocがPythonのためにPHPのためのパッケージがあるかもしれません。