Question

我知道以下所有模块都会生成rst，不包括index.rst

sphinx-apidoc -f -o very_good_docs/ very_good

以下内容生成所有内容，包括index.rst，conf.py，Makefile等

sphinx-apidoc -F -f -o very_good_docs/ very_good

问题是sphinx-apidoc没有生成正确的conf.py，所以我必须总是手动修改conf.py以包含正确的sys.paths。如果我修改我的python代码＆＃34; very_good＆＃34;文件夹，我应该运行没有＆＃34; -F＆＃34;的sphinx-apidoc命令，因此保留conf.py。但是，如果我直接在very_good下添加一个新模块，那么没有＆＃34; -F＆＃34;就不会更新index.rst;选项，这意味着我的新模块将不在doc中。我想解决方案是有人生成index.rst文件，或使用＆＃34; -F＆＃34;选项没有覆盖conf.py.有办法吗？

Answer 1

这是我现在正在经历的事情。没有找到信息来实现如此普遍的事情真是令人沮丧。

我的方法是使用自定义config.py并指定它始终使用sphinx-build选项执行-F。这样，即使创建了新的（无用的）config.py，我的config.py也不会被覆盖。

要指定自定义config.py，您应该使用文档中所述的-c选项：

-c path

Don’t look for the conf.py in the source directory, but use the given configuration directory instead. Note that various other files and paths given by configuration values are expected to be relative to the configuration directory, so they will have to be present at this location too.

New in version 0.3.

命令如下所示：

sphinx-build -b html -c %sphinxConfigDir% %sourceCode% %buildDir%

希望这有帮助。

如何单独生成index.rst或者通过sphinx-apidocs生成除conf.py之外的所有内容？

1 个答案: