没有侧边栏、页眉、页脚的狮身人面像



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

如果我们在 MATLAB 中集成狮身人面像文档,这看起来不太好,因为 MATLAB 文档已经有这些东西,所以狮身人面像吊坠是多余的。

有没有办法在没有所有这些额外东西的情况下使用 sphinx 创建 HTML 页面?

我已经在这里寻找主题"侧边栏"https://www.sphinx-doc.org/en/master/theming.html 例如,在堆栈溢出上。但几乎所有问题都与如何添加更多柱线有关,而不是删除它们。

我想我至少解决了这个问题,以满足我们的需求。

要删除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 帮助。

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

最新更新