Sphinx index.rst inside目录

Question

可以在conf.py中指定Sphinx构建的主文档的路径。但是，此目录路径反映在生成的HTML中，例如，在“将文档作为缺少的索引读取”中显示。我想使用这种替代方法来整洁地构建我的项目--在顶层进行配置并在src中编写文档，但在构建过程中从根本上摆脱它。

所以这是我之前得到的：

docs
    conf.py
    index.rst
    things
        doc1.rst
        doc2.rst

这是可行的，但是当很多文件被添加到顶层时，它会弄乱Sphinx的makefile等等。

docs
    conf.py
    src
        index.rst
        things
            doc1.rst
            doc2.rst

构建，但是index.html在build/html/src中，而不是build/html中。令我惊讶的是，除了conf.py中的master_doc控制主文件的位置和名称之外，我没有找到任何关于这方面的信息。如何才能将我的文档构建为build/html

Answer 1

有一个用于指定配置文件位置的选项：-c。

# conf.py
master_doc = 'index'

# structure
docs
    conf.py
    src
        index.rst
        ...

然后运行sphinx-build -b html -c . src build/html。然而，这个解决方案确实需要控制构建命令，而这在Read the Docs中是不可用的。而且似乎-c在Sphinx自己的makefile中也不能工作(使用-M而不是-b)。