控制 sphinx generated.rst 文件的保存位置

Question

赏金将在 3 天后到期。 此问题的答案有资格获得+50声望赏金。 Mathieu希望引起对这个问题的更多关注。

假设 sphinx 的文档结构如下：

doc
 |_ _static
 |_ _templates
 |_ api
     |_ index.rst
     |_ classes.rst
     |_ functions.rst
 |_ index.rst
 |_ more_functions.rst
 |_ conf.py

并且classes.rst 、 functions.rst和more_functions.rst具有使用autodoc/autosummary自动记录的类和函数。 构建将为这些类和函数生成.rst文件：

• doc/generated为more_functions.rst生成
• 为classes.rst和functions.rst doc/api/generated

有没有办法控制这些generated的文件夹的创建位置？

---

我最终试图获得一个唯一的generated文件夹。 在这种情况下，使用这种结构：

doc
 |_ generated
     |_ generated-from-more-functions.rst
     |_ api
         |_ generated-from-api/classes.rst
         |_ generated-from-api/functions-rst

Answer 1

根据Sphinx 文档，您可以使用选项BUILDDIR运行sphinx-build 。

BUILDDIR 要使用的构建目录，而不是在 sphinx-quickstart 中选择的目录。

我猜您提到的默认文件夹在技术上是由sphinx-quickstart选择的。

例子：

sphinx-build -b html sourcedir builddir

您可以通过子进程或使用os.system(command)运行命令。

Answer 2

我不认为sphinx有这样的原生功能。

实现这一目标的最快方法是创建一个 shell 脚本来运行构建，然后根据您的需要移动（如果您使用的是 gnu/linux，则使用mv或rm ）文件。