【问题标题】:Sphinx without sidebars, header, footer,没有侧边栏、页眉、页脚的狮身人面像,
【发布时间】:2019-08-13 08:56:14
【问题描述】:

我们想为我们的 MATLAB 代码创建一个 sphinx 文档。通常主题(雪花石膏、readthedocs、...)提供侧边栏、页眉、页脚、搜索引擎等。

如果我们在 MATLAB 中集成 sphinx 文档,这看起来不太好,因为 MATLAB 文档已经有了这些东西,所以 sphinx 挂件是多余的。

有没有办法用 sphinx 创建 HTML 页面而不需要所有这些额外的东西?

例如,我已经在https://www.sphinx-doc.org/en/master/theming.html 和这里查找了关于堆栈溢出的主题“侧边栏”。但几乎所有问题都与如何添加 MORE 条有关,而不是删除它们。

【问题讨论】:

  • Here有人把雪花石膏主题的侧边栏去掉了。
  • 感谢您的意见。我有与第一个链接相同的问题。我使用 rtd 主题,只是希望左侧边栏消失。主题中没有此选项。关键可能是 qthelp 输出。这仅打印内容,没有任何其他内容,也没有任何布局。这基本上是我想要的,但它也很“赤裸”。

标签: python html matlab python-sphinx


【解决方案1】:

我猜我至少解决了我们需要的问题。

要删除 rdt 主题中的面包屑、侧边栏和页脚,必须真正自定义定义这些内容的 css 文件。展开后,css文件大约有6000行代码,我们不想碰。

相反,我稍微变形了 qthelp 配置文件。 qthelp 允许使用所需的所有选项指定替代主题:

qthelp_theme = 'classic'
qthelp_theme_options = {
    # Basic
    'nosidebar': True,
    'body_max_width': 'None',
    'rightsidebar': False,
    'stickysidebar': False, 
    'collapsiblesidebar': False,
    'externalrefs': False,
    # Styling
    'footerbgcolor': '#FFFFFF', 
    'footertextcolor': '#1A1A1A',
    ...
}

这也会产生一个至少没有侧边栏的“裸”html 页面,我们可以对其进行自定义以使其看起来更像 rtd 主题。

在构建文档时,我们可以做两次。第一次运行与

$ make html

第二个是

$ make qthelp

第一个用于我们文档的 Web 表示,第二个用于 MATLAB 帮助。

我想我们可以接受这个解决方案。

【讨论】:

    猜你喜欢
    • 2010-12-14
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2015-08-22
    • 1970-01-01
    • 2023-03-16
    • 2013-02-21
    • 2011-07-28
    相关资源
    最近更新 更多