Sphinx Read-The-Docs 主题已识别但未“找到”

Question

我从 Github 下载了 sphinx 的 read-the-docs 主题并将其放入 _themes 文件夹中。

conf.py：

html_theme = "sphinx_rtd_theme"
html_theme_path = ["_themes", ]

但是，运行“make html”时出现此错误：

Sphinx v4.1.2 in Verwendung
Lade Übersetzungen [de]…erledigt
loading pickled environment... erledigt
WARNING: sphinx_rtd_theme (< 0.3.0) found. It will not be available since Sphinx-6.0

Theme error:
no theme named 'sphinx_rtd_theme' found (missing theme.conf?)

不知何故，斯芬克斯似乎找到了主题，然后忽略了它。有人可以告诉我发生了什么事以及如何解决它吗？

Answer 1

需要安装：

pip install sphinx-rtd-theme

Answer 2

我解决了它！（与OP不同，因为他没有安装该软件包，但也许这对某人有用）

如果它不适合您，请在

sure to use underscores

文件中添加

conf.py

，因为该包使用普通破折号。

在

conf.py

中应该是这样的

html_theme = 'sphinx_rtd_theme'

不是这样的

html_theme = 'sphinx-rtd-theme'

https://pypi.org/project/sphinx-rtd-theme/

Answer 3

我使用requirements.txt文件解决了这个问题，我用它来安装sphinx_rtd_theme模块。按照提到的步骤操作，我假设您有一个与 readthedocs 服务器连接的 GitHub 存储库。

1. 在 .ymal 文件中添加以下行

python:
   install:
     - requirements: docs/requirements.txt

2. 现在将包含以下文本的requirements.txt文件放置在上面指定的位置

   sphinx-rtd-主题

3. 添加、提交并将更改推送到源并享受！

Answer 4

我使用Some Dev提到的下划线点解决了它，但我还需要将

pip

更新到最新版本：

python.exe -m pip install --upgrade pip

Answer 5

如果您正在使用

venv

- 您应该重新启动 shell。这对我有用。