python - 在使用 Sphinx 文档时，我应该告诉我的 VCS 忽略哪些文件？

Question

关闭。这个问题是 opinion-based .它目前不接受答案。

---

想要改进这个问题吗？ 更新问题，以便 editing this post 提供事实和引用来回答它.

关闭 4 年前。

Improve this question

我想开始使用 Sphinx记录我的项目。我告诉 Sphinx 在 sphinx-quickstart 期间使用单独的源代码和构建目录。现在我的目录布局如下:

MyProject/
    myproject/
        __init__.py
        mymodule.py
    docs/
        source/
            .static/
            .templates/
            conf.py
            index.rst
        build/
        Makefile

应该从 Sphinx 项目的 VCS 存储库中排除哪些文件(即，由于我使用 Git，我应该将什么添加到我的 .gitignore 文件中)？例如，我是否应该忽略 docs/build/ 目录以便不跟踪从 Sphinx 生成的 HTML 页面中的更改？

Answer 1

如果您查看 Makefile 的内容，您会看到如下内容:

BUILDDIR      = build

...

clean:
    -rm -rf $(BUILDDIR)/*

这意味着 make clean 只是删除 build 目录，因此，关于版本控制，忽略 build 目录的内容应该已经足够了。