用于版本控制的单独 sphinx 构建和源目录

【问题标题】：separate sphinx build and source directories for version control用于版本控制的单独 sphinx 构建和源目录
【发布时间】：2013-05-17 20:27:31
【问题描述】：

我有一个包含我的项目的工作目录，它位于版本控制系统中。我想在我的项目中创建一个doc 目录，其中包含仅为sphinx 重组的文本文件。

也就是说，我不希望 sphinx 在我的项目中构建 html 文件，而是将它们放在外面，这样它们就不会进入版本控制。

【问题讨论】：

【解决方案1】：

因此，如果您的问题是“我如何在源代码树之外构建文档”，documentation 可以帮助您：

sphinx-build -b html sourcedir builddir

只需将 builddir 指向源代码树之外的位置即可。

或者，根据您的版本控制系统，将您生成文档的目录添加到“忽略文件”（例如.gitignore、.hgignore、...）

【讨论】：

我正在使用 sphinx-quickstart 进行尝试——文档确实有帮助，感谢您将我指向正确的位置。
对我来说，这种方法仍然会在源代码文件夹中查找 index.rst...我尝试在我的自定义 config.py 中指定 master_doc 选项，但它不起作用。