README

PHPDoc 到 reStructuredText

Doc2rst 从 PHP 源树生成reStructuredText。生成的 reStructuredText 可以再次作为Sphinx的源，Sphinx 是一个功能丰富的工具，可以构建 HTML 等多种格式的文档。

Doc2rst 使用 PHP 编写。
需求：php >=8.1
文档：https://doc2rst.readthedocs.io/en/latest/index.html

下载最新的 phar 文件，并将其放置在项目根目录中。假设您的文档文件夹名为 docs，则发出快速入门命令

 ./doc2rst.phar -q ./docs

这将把 3 个配置文件放置在您的 docs 文件夹中。检查并修改 docs/d2r-conf.php，然后运行

 ./doc2rst.phar -r ./docs

这将生成 docs/api 文件夹中的 reStructuredText 文件。

由于您可能只在开发期间需要 doc2rst，因此您可以在 composer 命令中添加 –dev 选项

 composer require --dev bhenk/doc2rst

假设您的文档文件夹名为 docs，运行快速入门以在您的 docs 文件夹中安装配置文件

 $process = new ProcessManager("path/to/docs");  
 $process->quickStart();

这将把 3 个配置文件放置在您的 docs 文件夹中。检查并修改 docs/d2r-conf.php，然后运行

 $process = new ProcessManager("path/to/docs");  
 $process->run();

这将生成 docs/api 文件夹中的 reStructuredText 文件。

有关配置选项的详细讨论，请参阅运行配置（RC 枚举）。