我有一个github存储库，我最近注意到文档（通过doxygen创建）也已上传到repo，因为它与源代码位于同一文件夹中。
现在我的问题：通常的做法是，还要在回购中提供文档（html，latex）吗？
答案 0 :(得分：1)
我猜是这样的，因为你提到过doxygen。
如果您自动构建文档，则没有理由将其置于版本控制之下（出于同样的原因，您不会将编译后的二进制文件置于版本控制之下）。
通常建议忽略构建文档的文件夹（即repository/doc_build），方法是使用以下行在存储库的根目录中创建.gitignore文件：
doc_build/
这会阻止意外推送该文件夹。
另一方面，如果项目以标记语言（如Markdown，reStructuredText等）编写代码文档，那么将文档的源代码置于版本控制之下是有意义的。
这是有道理的，因为通过这种方式，您可以在文档上与其他人协作（除了协作代码之外）。通常，对代码的更改意味着对文档进行更改：通过这种方式，您可以在一次提交中执行这些更改。
甚至还有像 readthedocs.org 这样的服务用于托管你的文档，它允许你从github导入它（当你从github更改它时自动重建它）。
作为一个例子，这个github项目将文档保持在版本控制之下（并且还提供了编译版本）：