hookedmedia / phpdoc-to-rst
从PHPDoc生成Sphinx/ReStructured文档
0.1.0
2018-09-05 17:25 UTC
Requires
- phpdocumentor/reflection: ^4.0.0
- phpdocumentor/reflection-common: 1.0.1
- phpdocumentor/reflection-docblock: 5.0.0-alpha3 as 4.3.0
- symfony/console: ^4.0
Requires (Dev)
- phpunit/phpunit: ^7
This package is not auto-updated.
Last update: 2024-09-13 09:09:29 UTC
README
从PHPDoc注释生成基于Sphinx的reStructuredText文档。
本项目主要基于 phpDocumentor/Reflection,并使用 sphinxcontrib-phpdomain。
文档输出示例可以在我们的 文档中找到
快速入门
将phpdoc-to-rst安装到您的项目目录中
composer require --dev juliushaertl/phpdoc-to-rst
运行命令行工具,解析包含您的PHP树的文件夹,并将reStructuredText文件渲染到输出目录
./vendor/bin/phpdoc-to-rst docs/api/ src/