Sphinx构建的主文档的路径可以在conf.py
中指定。但是,此目录路径反映在生成的HTML中,例如在“读取文档”中显示为缺少索引。我想使用此替代路径来清晰地构建我的项目-在src
中包含顶级配置和文档,但实际上摆脱了构建。
所以这是我以前的内容:
docs
conf.py
index.rst
things
doc1.rst
doc2.rst
这是可行的,但是当将大量文件添加到顶层时,它会与Sphinx的makefiles等混在一起。我想改用它:
docs
conf.py
src
index.rst
things
doc1.rst
doc2.rst
哪个版本,但是index.html
位于build/html/src
中,而不是build/html
中。除了master_doc
中的conf.py
控制主文件的位置和名称之外,我没有找到任何相关信息感到惊讶。如何将我的文档构建到build/html
?
有一个用于指定配置文件位置的选项:-c
。
# conf.py
master_doc = 'index'
# structure
docs
conf.py
src
index.rst
...
然后运行sphinx-build -b html -c . src build/html
。但是,此解决方案确实需要控制build命令,而该命令在Read The Docs中不可用。而且似乎-c
在Sphinx自己的makefile中也不起作用(用-M
代替-b
)。