在Sphinx中切换页面内容和折叠警告。
sphinx-togglebutton的Python项目详细描述
斯芬克斯切换按钮
一个小的狮身人面像扩展，可以添加一个“切换按钮”到 页面的部分。这允许您：
- 折叠斯芬克斯警告（注释、警告等），以隐藏其内容 直到用户单击切换按钮。在
- 使用
collapse指令折叠页面上的任意内容块。在
安装
您可以使用pip安装sphinx-togglebutton：
pip install sphinx-togglebutton
使用
在conf.py配置文件中，添加sphinx_togglebutton
你的扩展列表。在
例如：
^{pr2}$现在，无论何时您希望警告能够切换，请添加
:class: dropdown参数。在
例如，此代码将创建一个可切换的“注意”警告 开始隐藏：
..note:::class: dropdown This is my note.
单击切换按钮将切换项目的可见性。在
您也可以在默认情况下显示内容。为此，请添加dropdown
类以及atoggle-shown类，如下所示：
..note:::class: dropdown, toggle-shown This is my note.
您还可以使用containers添加任意可切换的代码。例如， 这是一个里面有图像的容器：
..container:: toggle, toggle-hidden ..admonition:: Look at that, an image! ..image:: https://media.giphy.com/media/mW05nwEyXLP0Y/giphy.gif
- 项目
标签：
欢迎加入QQ群-->： 979659372
