juliushaertl/phpdoc-to-rst

此包已被废弃，不再维护。没有建议的替代包。

从PHPDoc生成Sphinx/ReStructured文档

维护者

详细信息

github.com/juliushaertl/phpdoc-to-rst

源代码

问题

安装量: 10,830

依赖项: 1

建议者: 0

安全: 0

星标: 3

关注者: 1

分支: 7

开放问题: 8

dev-master 2018-05-28 16:27 UTC

Requires

Requires (Dev)

AGPL-3.0-or-later 9a695417d1f3bb709f60cd5c519e46f1ad08c843

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

This package is auto-updated.

Last update: 2020-08-27 16:27:44 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/