如何将 Sphinx 指向自定义主题

Question

注意：我之前问过这个问题，但因为我放弃了这个项目而删除了它，但现在我实际上需要找出如何解决。

我正在尝试制作 Sphinx 主题，但我无法让 Sphinx 检测到我的主题。我的文件夹结构看起来像这样：

.
docs
   conf.py
   makefile
   make.bat
   index.md
custom_theme
   theme.toml
   layout.html

我将在我的

conf.py

文件中指出主题：

html_theme = 'custom_theme'

但是，Sphinx 将返回以下错误：

Theme error:
no theme named 'custom_theme' found (missing theme.toml?)
Sphinx exited with exit code: 2

如何让 Sphinx 使用我的自定义主题构建文档？

其他背景： 我使用 Myst-Parser 是因为我更喜欢 markdown 而不是 reStructuredText，而且我还使用 Sphinx Autobuild。根据 Sphinx Autobuild 文档，我显然使用此命令运行

sphinx-autobuild -a docs docs/_build/html --watch custom_theme

，Sphinx 可以检测自定义主题。

如果您需要更多背景信息，请告诉我，我们将不胜感激。谢谢。

Answer 1

我会这样做：

1. 将主题放入

   _themes

   文件夹内的

   docs

   文件夹中。
2. 在conf.py中，添加

   html_theme_path = ['_themes']

   （除了您已有的

   html_theme = 'custom_theme'

   之外）。

示例：https://github.com/sphinx-doc/sphinx/blob/master/doc/conf.py#L36