PHP 的外部文档,无 DocBook
我需要一个 PHP 项目的文档系统,并且希望它能够将外部文档(用例、项目范围等)与代码注释生成的文档集成。看起来 phpDocumentor 具有完全正确的功能集,但外部文档必须用 DocBook 编写,这对我们团队来说太复杂了。
如果是用 python 编写,sphinx 就非常适合这项工作(ReST 肯定比 docbook 简单)。有没有什么方法可以将外部 ReST 文档与从 phpdoc 中提取的文档集成?我是否应该将外部文档分开(例如,使用 ReST 表示外部文档,使用 phpdoc 表示内部文档)?或者您对管理外部文档有更好的建议吗?
I need a documentation system for a PHP project and I wanted it to be able to integrate external documentation (use cases, project scope etc.) with the documentation generated from code comments. It seems that phpDocumentor has exactly the right feature set, but external documentation must be written in DocBook which is too complex for our team.
If it were in python, sphinx would be just about perfect for this job (ReST is definitely simpler than docbook). Is there any way I can integrate external ReST documentation with the docs extracted from phpdoc? Should I just separate the external documentation (eg. use ReST for external and phpdoc for internal)? Or do you have a better suggestion for managing the external documentation?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(2)
您可以使用 pandoc 将 ReST 转换为 DocBook。
You can convert ReST to DocBook using pandoc.
将 WordPress 帖子转换为 DocBook 风格。这是样本。
http://hashfold.com/techfold/wordpress-how-生成 docbook-style-posts/
convert wordpress posts in DocBook style. here is the sample.
http://hashfold.com/techfold/wordpress-how-to-generate-docbook-style-posts/