tk.phpautodoc 1.2.1

tk.phpautodoc

tk.phpautodoc是sphinx扩展，用于将PHPDocs嵌入到sphinx文档中。它类似于sphinx.ext.autodoc。

安装

安装此软件包并将“sphinxcontrib_phpautodoc”添加到扩展列表中

# in conf.py
extensions += ['sphinxcontrib.phpdomain', 'sphinxcontrib_phpautodoc']

这就完成了。

指令

phpautomodule

phpautomodule类似于sphinx.ext.autodoc中的automodule指令。它解析.php文件，然后从您的文档中提取函数、类和方法。

示例

.. phpautomodule::
   :filename: path/to/source_code.php
   :members:
   :undoc-members:

phpautoclass

phpautoclass类似于sphinx.ext.autodoc中的autoclass指令。它解析.php文件，然后从您的文档中提取类及其成员。

示例

.. phpautoclass:: MyClass,MySubClass
   :filename: path/to/source_code.php
   :members:
   :undoc-members:

如果您未指定任何类名，phpautoclass将选择.php文件中的所有类。

示例

.. phpautoclass::
   :filename: path/to/source_code.php
   :members:
   :undoc-members:

phpautofunction

phpautofunction类似于sphinx.ext.autodoc中的autofunction指令。它解析.php文件，然后从您的文档中提取函数。

示例

.. phpautofunction:: my_function
   :filename: path/to/source_code.php

LICENSE

Apache License 2.0