使用Sphinx生成独立的html文件

时间:2017-10-08 16:11:09

标签: html documentation python-sphinx

我对Sphinx很新,我正在尝试为我的应用程序创建文档。 为每个主题生成一个“独立的”html文件会很好。

我的意思是:Sphinx在左侧创建了一个有用的导航面板,包含一些模块(toc,下一个主题,搜索等等)。但这是放在每个 html!

我想在我的应用程序中添加一个上下文帮助:每当用户将焦点设置在(相关)小部件上时,相关的html就显示在一个框中。 当然我不想在这里显示导航面板!

是否可以配置Sphinx生成仅包含主题内容的html文件,然后使用主html(index.html)在框架中显示它们?

2 个答案:

答案 0 :(得分:1)

默认HTML输出(使用html构建器时)包含大多数主题的侧边栏(导航窗格),通常位于左侧。

还有其他输出格式,例如HTML Help and Qt Help,其中构建器生成没有侧边栏的HTML文件。使用其中之一。

这些构建器的文档说“这个构建器产生与独立HTML构建器相同的输出......”,但这会误导恕我直言。输出不一样。

答案 1 :(得分:0)

这对我有用:https://stackoverflow.com/a/53212488/2636544,即在conf.py中添加以下内容:

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

适用于alabaster主题。