code-snippets - Sphinx、reStructuredText 显示/隐藏代码片段

Question

我一直在使用 Sphinx 记录一个软件包和 reStructuredText .

在我的文档中，有一些很长的代码片段。我希望能够将它们隐藏为默认值，并带有一个可以展开它们的小“显示/隐藏”按钮( Example )。

有没有标准的方法来做到这一点？

Answer 1

我认为最简单的方法是创建一个自定义 Sphinx 主题，您可以在其中告诉某些 html 元素具有此功能。一个小的 JQuery 在这里会有很长的路要走。

但是，如果您希望能够在 reStructuredText 标记中指定它，则需要

将这样的东西包含在 Sphinx 本身或

中

在 Sphinx/docutils 扩展中实现它……然后创建一个了解此功能的 Sphinx 主题。

这将是更多的工作，但会给你更多的灵活性。