python - 如何在 sphinx 文档中显示和隐藏代码？

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 ) 以生成“弹出窗口” <div>带有代码片段和显示/隐藏它的链接。源代码在sqlformatter.py .

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

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

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

Python 文档

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

该功能在 copybutton.js 中实现.