如何在git仓库上正确提交生成的文档?

时间:2018-10-07 07:50:58

标签: git github

我在一个项目中,需要在github存储库上提交生成的文档。

问题在于文档代表了大量生成的代码行,这些代码行被视为github上的书面行。

现在我将文件夹添加到.gitignore

文档算作代码行是一个问题吗?如果是这样,是否有解决此问题的方法?

感谢任何答案

1 个答案:

答案 0 :(得分:0)

如果这些文档是以某种方式自动生成的(例如javadoc,sphinx,doxygen),我不会将文档提交给git。我只提交用于生成此文档的源代码和脚本,并在自述文件中添加一节以说明其生成方式。这样,任何需要它的贡献者都可以轻松地生成它,但是您不会“污染”存储库中巨大的变更集。