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

Question

我希望在 Sphinx、reStructuredText 显示/隐藏代码片段中提及相同的功能。但该帖子上没有共享代码。

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 格式化程序 (PopupSQLFormatter)，以便生成带有代码片段和显示/隐藏它的链接的“弹出”

。源代码位于 sqlformatter.py 中。

显示/隐藏切换由 init.js。

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

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

Python 文档

Python 文档中的许多代码示例都具有一个“按钮”，用于切换交互式提示的显示（>>>、...）和 doctest 中的输出-风格的代码片段。有了提示和输出，就可以更轻松地复制和粘贴代码。以下是几个示例： http://docs.python.org/library/datetime .html#module-datetime。

该功能在 copybutton.js 中实现。