制作htmlhelp时如何使用Sphinx RTD主题隐藏侧边栏

Question

在 ReadTheDocs 主题下使用 Sphinx 时是否可以隐藏边栏？

再扩展一下问题，我可以让它在发出命令时包含侧边栏吗：

$ make html

并且不包括它发出命令：

$ make htmlhelp

不修改代码？也许在 layout.html.

中添加一些内容

Answer 1

首先，将两个问题合二为一是一种糟糕的形式post。下次，创建一个单独的问题。

对于您的第一个问题，我不确定选项 collapse_navigation 的实际作用，但它的名称暗示它可以满足您的需求。默认值为 False，因此将其切换为 True，看看会发生什么。查看其他 Read the Docs theme configuration options.

对于你的第二个问题，至少有两种方法。

您可以使用 sphinx-build 的 -D 选项并覆盖 conf.py 中的设置。

您可以有多个 conf.py 文件（按照您认为合适的方式命名），并使用 -c 选项 select 为您想要的输出选择合适的文件。

Answer 2

在 alabaster 主题中，我可以通过将以下内容添加到我的 conf.py 文件中来删除 TOC/sidebar：

html_theme_options = {
    # Disable showing the sidebar. Defaults to 'false'
    'nosidebar': True,
}

我在 sphinx_rtd_theme 中对此进行了测试，但没有用。但是，我将其添加为此处的答案，因为它可能对其他试图删除 其他主题 中的侧边栏的人有所帮助（就像我的情况一样）。

Answer 3

为了构建 matlab 文档（我认为它类似于 HTMLHelp），我发现可以使用额外的 CSS:

来隐藏边栏

.wy-nav-side {
  display: none;
}

.wy-nav-content-wrap {
  margin-left: 0;
}

然后在 conf.py 文件中我添加了 CSS 文件：

html_static_path = ['_static']

html_css_files = [
    'css/matlabdoc.css',
]

这不会删除边栏，但至少会隐藏它。可能有帮助。

查看 RTD 主题，也可以删除侧边栏通过更改 conf.py 中的 search.html 和 localtoc.html 默认文件通过使用 html_sidebars = {}.

设置它们

How to hide the sidebar using Sphinx RTD theme when making htmlhelp