不确定这应该在这里还是在程序员身上。
生成 API 文档
我想就如何为内部项目生成 API 文档提供一些建议。我对 Git 相对较新，我们正在尝试实现一些合理的构建/部署实践。
我们讨论的一件事是确保我们的代码库有很好的文档记录，并使用PhpDocumentor2或许多类似工具之一生成文档。
我们已经开始实施类似于此处详述的工作流程。
我应该在构建文档时自动执行吗？
例如，标记发布时 git 中的提交前或提交后钩子。还是当我将开发合并到发布分支时，只需手动创建文档并提交到存储库？
为每个版本生成文档是标准做法吗？
我可能误解了这个过程，新的文档版本应该与 git 版本/标签相关联吗？
您在哪里存储生成的文档？
在同一个存储库中？是不同的存储库？托管在诸如"阅读文档"之类的地方还是仅在内部托管？我们目前正在进行的项目很小，但如果成功，我们希望将来将该过程推广到其他更大的项目中。
上下文
该项目是一个Magento扩展，我们希望提供API文档，单元测试和PSR兼容代码。我缺乏关于整个工作流程如何集成的信息。PHPunit 和 PHPDocumentor2 通过 Composer 在本地安装。
我听说过并看过Travis Ci，但我不确定Docs是否属于这一类。
这个问题可能看起来微不足道和/或微不足道，但是，我在集成和 git 工作流程方面没有太多经验，我找不到太多信息。
生成的文档通常为：
- 始终与代码源同步（因此"新文档版本是否应该与 git 版本/标签相关"的问题变得毫无意义）
- 不存储在版本控制引用（如 Git 存储库）中，而是随意（重新）生成（在您喜欢的任何位置）。
如果你看一个具有大型代码源和大量代码文档的项目，你可以以语言 Go 和他的存储库为例（一个可变的存储库，但你在 GitHub 上也有镜像）
- 静态文档，如规格、文章、发行说明等。保留在存储库中，因为它们不是生成的，而是手动更新的，并且与源紧密链接。
- 代码文档单独保存在静态网站中。
- 所有 go 项目的文档都保存在一个静态网站 GoDoc 中，该网站将获取 Go 项目的源代码，并从中生成文档。