Php 在Git工作流中生成API文档

不确定这是在这里还是在电视上

生成API文档 我想要一些关于如何为内部项目生成API文档的建议。我对Git比较陌生，我们正在尝试实现一些合理的构建/部署实践

我们讨论的一件事是确保我们的代码库有良好的文档记录，并使用PhpDocumentor2或许多类似工具之一生成文档

我们已经开始实施类似于详细说明的工作流

---

我应该在构建文档时实现自动化吗？ 例如，标记发布时git中的预提交或后提交挂钩。或者，当我合并开发到发布分支时，是否应该手动创建文档并提交到存储库

为每个版本生成文档是标准做法吗？ 我可能误解了这个过程，新的文档发布是否应该与git发布/标记关联

您将生成的文档存储在哪里？ 在同一个存储库中？不同的存储库？托管在某个类似的地方还是仅在内部？ 我们目前正在进行的项目只是一个小项目，但如果成功的话，我们希望在将来将这个过程推广到其他更大的项目

上下文 该项目是一个Magento扩展，我们希望提供API文档、单元测试和符合PSR的代码。我缺乏关于整个工作流程如何集成的信息。PHPunit和PHPDocumentor2通过Composer在本地安装

我听过并看过Travis Ci，但我不确定文档是否属于这一类

---

这个问题可能看起来很琐碎，但我在集成和git工作流方面没有太多经验，也找不到太多相关信息。

生成的文档通常包括：

• 始终与代码源同步（因此“新的文档版本是否应该与git版本/标记相关”的问题变得毫无意义）
• 不是存储在版本控制引用（如git repo）中，而是随意（重新）生成（在您喜欢的任何位置）

如果你看一个拥有大量代码源和大量代码文档的项目，你可以拿and（mercurial repo，但你有）作为例子

• 静态文档，如回购协议中的KEPT，因为它们不是生成的，而是手动更新的，并且与来源紧密相连
• 单独保存在静态网站中
• 所有go项目的文档都保存在一个文件夹中，并从中生成文档

---

我也这么想，只是想澄清一下。因为这只是一个小的内部项目，我想我会把它留给谁拉项目生成文档，如果他们需要的话！谢谢你的回答。