在Sphinx中切换页面内容和折叠劝诫项。
项目描述
sphinx-togglebutton
一个小的sphinx扩展，允许向页面部分添加“切换按钮”。这允许你
- 折叠Sphinx劝诫项（注释、警告等），使其内容在用户点击切换按钮之前隐藏。
- 使用
collapse指令折叠页面上的任意内容块。
安装
您可以使用pip安装sphinx-togglebutton
pip install sphinx-togglebutton
使用
在您的conf.py配置文件中，将sphinx_togglebutton添加到您的扩展列表中。
例如。
extensions = [
...
'sphinx_togglebutton'
...
]
现在，每当您希望劝诫项可切换时，请将:class: dropdown参数添加到您使用的劝诫项指令中。
例如，此代码将创建一个可切换的“注释”劝诫项，默认隐藏
.. note::
:class: dropdown
This is my note.
点击切换按钮将切换项的可见性。
您还可以 默认显示内容。为此，除了添加dropdown类之外，还要添加toggle-shown类，如下所示
.. note::
:class: dropdown, toggle-shown
This is my note.
您还可以使用 容器 来添加任意可切换的代码。例如，以下是一个包含图像的容器
.. container:: toggle, toggle-hidden
.. admonition:: Look at that, an image!
.. image:: https://media.giphy.com/media/mW05nwEyXLP0Y/giphy.gif
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解更多关于 安装包 的信息。
源分布
sphinx-togglebutton-0.3.2.tar.gz (8.3 kB 查看哈希值)
构建版本
关闭
sphinx-togglebutton-0.3.2.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | ab0c8b366427b01e4c89802d5d078472c427fa6e9d12d521c34fa0442559dc7a |
|
| MD5 | bee9c0ef2f3c888085000efcad2d63b7 |
|
| BLAKE2b-256 | f0dfd151dfbbe588116e450ca7e898750cb218dca6b2e557ced8de6f9bd7242b |
关闭
sphinx_togglebutton-0.3.2-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 9647ba7874b7d1e2d43413d8497153a85edc6ac95a3fea9a75ef9c1e08aaae2b |
|
| MD5 | ea4c508d000340ee00f5628967bea009 |
|
| BLAKE2b-256 | e918267ce39f29d26cdc7177231428ba823fe5ca94db8c56d1bed69033b364c8 |
