我有一个 github 存储库，我最近注意到文档（通过 doxygen 创建）也已上传到 repo，因为它与源代码位于同一文件夹中。
现在我的问题是：这样做是常见的做法，还在 repo 中提供文档（html、latex）吗？
问问题
500 次
1 回答
1
“编译”文档
我想是这样，因为你提到了 doxygen。
如果您自动构建文档，则没有理由将其置于版本控制之下（出于同样的原因，您不会将编译后的二进制文件置于版本控制之下）。
通常建议忽略构建文档的文件夹（即），方法是使用以下行在存储库的根目录中repository/doc_build创建一个文件：.gitignore
doc_build/
这将防止意外推送该文件夹。
文档源代码
另一方面，如果项目使用标记语言（如 Markdown、reStructuredText 等）编写代码文档，那么将文档的源代码置于版本控制之下是有意义的。
这是有道理的，因为通过这种方式，您可以在一个地方与其他人就文档进行协作（除了在代码上进行协作）。通常对代码的更改意味着对文档的更改：通过这种方式，您可以在一次提交中完成这些更改。
甚至还有像readthedocs.org这样的服务来托管您的文档，它允许您从 github 导入它（并在您从 github 更改它时自动重建它）。
例如，这个 github 项目将文档置于版本控制之下（并且还提供了编译版本）：
- https://github.com/cms-dev/cms/tree/master/docs -- 版本控制下的文档文件夹
- https://cms.readthedocs.org——（自动）编译的版本
于 2013-09-16T20:37:57.147 回答