我想开始使用Sphinx来记录我的项目。在sphinx-quickstart
期间,我告诉Sphinx使用单独的源和构建目录。现在我的目录布局如下:
MyProject/
myproject/
__init__.py
mymodule.py
docs/
source/
.static/
.templates/
conf.py
index.rst
build/
Makefile
针对Sphinx项目,哪些文件应该从版本控制系统(VCS)仓库中排除(例如,由于我使用Git,我应该将什么添加到我的.gitignore
文件中)?例如,我是否应该忽略docs/build/
目录以便不跟踪Sphinx生成的HTML页面所做的更改?
docs
目录中的几乎所有(除了index.rst
)*.rst
文件都将被生成并且可以忽略。我建议您添加一个忽略规则,例如/docs/myproject.*
。 - Bengt