Python 更改sphinx构建主文件

我能告诉你sphinx build停止寻找

index.rst

吗

$ echo 'test' > readme.rst
$ sphinx-build -C . ./build readme.rst

这将投诉缺少索引文件

master file /.../index.rst not found

但是我们可以解决这个问题

$ ln -s readme.rst index.rst
$ sphinx-build -C . ./build readme.rst

这实际上会构建

index.rst

和

readme.rst

，并且它会抱怨

readme.rst

未包含在任何toc树中。可以使用

mv

而不是

ln

来修复。但是，我不想仅仅为了满足

sphinx build

拥有索引文件的wierd需求而移动文件。我也不想到处都有挥之不去的链接

我可以更改主文件的位置吗？类似于（不起作用的）：

或者我可以告诉它一起跳过索引文件吗？例如（不起作用的）：

或者有其他方法解决这个问题吗？

如何：

sphinx-build -C . ./build readme.rst -D master_doc='readme'    

更详细地说：

$ ls
readme.rst
$ sphinx-build -C . ./build readme.rst -D master_doc='readme'
Running Sphinx v1.8.5
making output directory...
building [mo]: targets for 0 po files that are specified
building [html]: 1 source files given on command line
updating environment: 1 added, 0 changed, 0 removed
reading sources... [100%] readme                                                          
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] readme                                                           
generating indices... genindex
writing additional pages... search
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded.

The HTML pages are in build.
$ ls
build       readme.rst

---

斯芬克斯3.0.2也适用于我。

首先将您的

索引.rst

重命名为

自述.rst

$ echo 'test' > readme.rst
$ sphinx-build -C . ./build readme.rst

然后，您可以在

conf.py

中指定值并生成文档，或者在生成文档时在命令行上的

conf.py

中重写该值

在

conf.py

$sphinx构建/建造

仅在命令行上指定

$sphinx构建/构建-D主文件

$ ls
readme.rst
$ sphinx-build -C . ./build readme.rst -D master_doc='readme'
Running Sphinx v1.8.5
making output directory...
building [mo]: targets for 0 po files that are specified
building [html]: 1 source files given on command line
updating environment: 1 added, 0 changed, 0 removed
reading sources... [100%] readme                                                          
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] readme                                                           
generating indices... genindex
writing additional pages... search
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded.

The HTML pages are in build.
$ ls
build       readme.rst