如何在 sphinx doc 中显示和隐藏代码？

Question

我希望在 Sphinx, reStructuredText show/hide code snippets 中提及相同的功能。但是该帖子上没有共享代码。

Answer 1

SQLAlchemy 文档

SQLAlchemy 文档使用特殊扩展名 (https://bitbucket.org/zzzeek/zzzeeksphinx/)。

文档源包含带有自定义选项和标记的标记，如下例所示：

.. sourcecode:: python+sql
 
    {sql}>>> engine.execute("select 1").scalar()
    select 1
    ()
    {stop}1

这由特殊的 Pygments lexer (PythonWithSQLLexer) 和 Pygments formatter (PopupSQLFormatter) 处理，以生成带有代码 sn-p 的“弹出窗口”<div> 和显示的链接/隐藏它。源代码在sqlformatter.py。

显示/隐藏切换由 init.js 中的 jQuery 魔术处理。

Mako 模板系统用于生成 HTML 页面（Sphinx 中的默认模板系统是 Jinja）。这是通过在mako.py 中继承TemplateBridge 来配置的。

在模板文件layout.mako 中，指定了CSS 和JavaScript 文件（包括init.js）的路径。有关 Sphinx 模板的更多信息，请参阅 http://sphinx-doc.org/templating.html。

Python 文档

Python 文档中的许多代码示例都有一个“按钮”，用于切换交互式提示（>>>、...）的显示并以 doctest 样式的代码 sn-ps 输出。通过提示和输出，可以更轻松地复制和粘贴代码。这里有几个例子：http://docs.python.org/library/datetime.html#module-datetime。

该功能在copybutton.js中实现。