Git 将代码文档置于版本控制之下是否是常见的做法？

我有一个github存储库，我最近注意到文档（通过doxygen创建）也已上载到repo，因为它与源代码位于同一文件夹中

现在我的问题是：在回购协议中提供文档（html、latex）是否也是一种常见的做法？

“编译”文档 我想情况就是这样，因为你提到了强氧

如果您自动生成文档，则没有理由将其置于版本控制之下（出于同样的原因，您不会将已编译的二进制文件置于版本控制之下）

通常建议忽略生成文档的文件夹（即

存储库/doc\u build

），方法是在存储库的根目录中创建一个

.gitignore

文件，并使用以下行：

doc_build/

这将防止意外推送该文件夹

文档的源代码 另一方面，如果项目使用标记语言（如Markdown、reStructuredText等）编写代码文档，那么将文档的源代码置于版本控制之下是有意义的

这是有意义的，因为通过这种方式，您可以在文档上与其他人协作（除了在代码上协作）。通常，对代码的更改意味着对文档的更改：通过这种方式，您可以在一次提交中完成这些更改

甚至还有像readthedocs.org这样的服务来托管您的文档，它允许您从github导入文档（并在您从github更改文档时自动重建文档）

例如，此github项目将文档置于版本控制之下（并提供编译版本）：

• --版本控制下的文档文件夹
• --（自动）编译的版本

“编译”文档 我想情况就是这样，因为你提到了强氧

如果您自动生成文档，则没有理由将其置于版本控制之下（出于同样的原因，您不会将已编译的二进制文件置于版本控制之下）

通常建议忽略生成文档的文件夹（即

存储库/doc\u build

），方法是在存储库的根目录中创建一个

.gitignore

文件，并使用以下行：

doc_build/

这将防止意外推送该文件夹

文档的源代码 另一方面，如果项目使用标记语言（如Markdown、reStructuredText等）编写代码文档，那么将文档的源代码置于版本控制之下是有意义的

这是有意义的，因为通过这种方式，您可以在文档上与其他人协作（除了在代码上协作）。通常，对代码的更改意味着对文档的更改：通过这种方式，您可以在一次提交中完成这些更改

甚至还有像readthedocs.org这样的服务来托管您的文档，它允许您从github导入文档（并在您从github更改文档时自动重建文档）

例如，此github项目将文档置于版本控制之下（并提供编译版本）：

• --版本控制下的文档文件夹
• --（自动）编译的版本