用sphinx_book_theme构建sphinx

Question

我正在尝试将sphinx与 sphinx beam theme 在我的文档中构建文档的问题。

设置

我安装了sphinx和主题的

pip install sphinx
pip install sphinx_book_theme
sphinx-quickstart

，并使用以下文档启动了：然后我将主题更改为phinx beam them

我的conf.py看起来像这样（已删除自动化注释）：

# -- Project information -----------------------------------------------------

project = 'mytest'
copyright = '2022, Me'
author = 'Me'
release = '0.1.0'


# -- General configuration ---------------------------------------------------

extensions = [
    'sphinx_book_theme' # I changed this
]
templates_path = ['_templates']
language = 'python'
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']


# -- Options for HTML output -------------------------------------------------

html_theme = 'sphinx_book_theme' # I changed this
html_static_path = ['_static']

构建

但是，当我尝试构建文档时，

sphinx-build docs . _build/html

：我会收到此错误：

Running Sphinx v4.5.0
loading translations [python]... not available for built-in messages
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: [new config] 1 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
Theme error:
An error happened in rendering the page index.
Reason: TemplateNotFound('sidebar-logo.html')

如何解决此问题并使用书籍主题？我需要创建一个侧边栏模板吗？如果是这样，如何以及在哪里？我没有针对我的项目的徽标，也不想创建一个徽标。

Answer 1

我自己找到了答案。似乎如果您删除行templates_path = ['_templates']它有效：

# -- Project information -----------------------------------------------------

project = 'mytest'
copyright = '2022, Me'
author = 'Me'
release = '0.1.0'


# -- General configuration ---------------------------------------------------

extensions = [
    'sphinx_book_theme'
]
# templates_path = ['_templates'] # REMOVE THIS LINE TO WORK
language = 'python'
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']


# -- Options for HTML output -------------------------------------------------

html_theme = 'sphinx_book_theme'
html_static_path = ['_static']

如果您在>“模板”中有某些内容，我怀疑您需要创建sidebar -logo.html在这里。不确定如何。