Sphinx 设计组件#

在本页上,您将找到用户界面组件,例如徽章、按钮、卡片和选项卡。

本页上的组件**不是由 PyData 主题提供的**。它们是由 Sphinx Design(一个 Sphinx 扩展)提供的。这意味着,如果您希望使用本页上的组件,则必须单独安装 Sphinx Design 并将其添加到您的 conf.py 中。

另请参见

要将 Sphinx Design 扩展添加到您的 Sphinx 项目,请参考 Sphinx Design - 入门

两个项目的贡献者都已努力确保兼容的样式,以便 Sphinx Design 组件在外观和感觉上与 PyData 主题保持一致。

本页显示了如果您在网站上使用 PyData 主题时使用 Sphinx Design 组件,这些组件将是什么样子。Sphinx Design 还提供了 Sphinx Design 网站的 PyData 主题版本;但是,他们的网站使用的是此主题的较旧版本。

您对主题所做的任何自定义都可能会影响这些组件在您网站上的显示方式。因此,即使您的网站使用了此主题,您在本页上看到的内容也可能与您在网站上看到的内容不完全匹配。

卡片#

只有标题

只有主体。

但具有多个文本段落。

标题和主体

第三张卡片的内容。

示例徽章

带有下拉菜单的卡片
点击展开下拉菜单

隐藏的内容

可点击的卡片

不要忘记使用 link-alt 添加替代文本!

可点击的卡片 - Sphinx Design 文档

面板 1 标题

面板 1 内容 更多内容

面板 2 标题

面板 2 内容

选项卡#

int main(const int argc, const char **argv) {
    return 0;
}
def main():
    return
class Main {
    public static void main(String[] args) {
    }
}
function main()
end
PROGRAM main
END PROGRAM main

复制按钮#

sphinx-copybutton 将复制按钮添加到您的每个代码单元中。您可以通过将鼠标悬停在下面的代码单元上来查看它的实际效果

print("A copybutton in the top-right!")

nbsphinx

如果您的文档站点同时使用 nbsphinx 和 Sphinx-copybutton,您将需要在 conf.py 文件中添加以下行,以防止复制按钮出现在笔记本单元格编号之上

conf.py#
copybutton_selector = ":not(.prompt) > div.highlight pre"

切换按钮#

sphinx-togglebutton 允许您将注意事项转换为可切换的元素。

一个独立的切换按钮!