在`setup.py`上使用Sphinx的`BuildDoc`

Question

我正在选择一个 Python 项目，该项目在

setup.py

脚本中包含以下内容：

from sphinx.setup_command import BuildDoc

commands["build_sphinx"] = BuildDoc
cmd_opts["build_sphinx"] = {
    "project": ("setup.py", NAME),
    "version": ("setup.py", about["__version__"]),
    "release": ("setup.py", about["__version__"]),
    "source_dir": ("setup.py", "docs"),
}

这是从

setuptools

传递到 setup()。 现在这给了我一个导入错误，因为它找不到该模块。 从 Sphinx 文档中我们可以得到：

# this is only necessary when not using setuptools/distribute
from sphinx.setup_command import BuildDoc

http://code.nabla.net/doc/sphinx/api/sphinx/setup_command/sphinx.setup_command.BuildDoc.html

所以我的问题是我是否可以从某个地方导入这个

BuildDoc

，或者我应该像文档建议的那样以另一种方式使用setuptools，如果是这样我该怎么做？

我还将在项目中添加Poetry，因此如果有“Poetry with Sphinx thing”，我可能会想要它。

我尝试寻找

BuildDoc

导入。

我现在知道 Sphinx 与 setuptools 的集成在 Sphinx 7.0.0 中已被弃用，还有办法集成吗？

Answer 1

BuildDoc

是命令行 sphinx-build 的 Python 版本。 我通过完全摆脱安装工具来解决这个问题，只需添加到 makefile 中即可：

poetry run sphinx-build

就像sinoroc提完一样！谢谢