【问题标题】:Configuring source dir for Sphinx documentation conf.py file为 Sphinx 文档 conf.py 文件配置源目录
【发布时间】:2023-02-18 21:14:34
【问题描述】:
我得到了一个要上传到本地 devpi 服务器的包。我在无法找到 Sphinx 的 conf.py 文件时遇到了一些问题,这很有意义,因为它查看的是 (package_name)/docs 文件夹而不是我使用的 (package_name)/docs/source,并且其中还包含所有 RST 文件。我如何在 pyproject.toml 中配置 Devpi 以将 sphinx source_dir 设置为 (package_name)/docs/source?
它肯定可以使用 sys.path.append() 以某种方式解决,然后更改配置的路径,但我确实想知道它的配置以及它是否受支持。
【问题讨论】:
标签:
python
python-sphinx
devpi
【解决方案1】:
在devpi-client 版本 5.2.3 中它应该可以工作。
因为变化:
“在构建文档时使用 sphinx-build 命令而不是 setup.py build_sphinx。”在版本 6.0.0 中,上传例程不会“识别”您的本地目录结构。
但我还没有找到如何将参数传播到 sphinx-build 以指定文档源目录。
【解决方案2】:
对此的更新。
它在 devpi-client 中硬编码了它如何构建文档。
我发现 devpi 客户端已经实现支持 (package_name)/docs/source 目录。
下一个版本的 devpi-client 将包括这个,但它仍然被硬编码为 2 个路径并且不允许以不同的方式放置它。