groensch24 / phpdoc-to-rst

从PHPDoc生成Sphinx/ReStructured文档

维护者

详细信息

github.com/groensch24/phpdoc-to-rst

源代码

安装: 7

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 10

dev-master 2022-10-07 15:40 UTC

Requires

Requires (Dev)

AGPL-3.0-or-later 273641a0485bfe38c5093b5d0f55b0c68b8664dc

  • Julius Härtl <jus.woop@bitgrid.net>

This package is not auto-updated.

Last update: 2024-09-21 23:02:46 UTC

README

Documentation Status Build Status Scrutinizer Code Quality

从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/