Sphinx扩展用于OS代码块
项目描述
Sphinx的osexample扩展
这是Serge Domkowski的examplecode扩展的修改分支，用于Sphinx。
关于
这是一个简单的扩展，当作为HTML渲染时，它将折叠包含不同操作系统管理示例的多个代码块，并可以通过按钮切换到另一个块。
它旨在用于显示包管理器示例。（例如，apt install或dnf install）。
此扩展添加了example-code指令，它为应折叠的代码块的外部容器添加一个类。该类允许包含的JavaScript和CSS渲染折叠的块和按钮。
目前支持：Debian，Ubuntu，Fedora，CentOS，OSX
快速示例
源代码看起来可能像这样
.. example-code::
.. code-block:: Debian
sudo apt install htop
.. code-block:: Fedora
sudo dnf install htop
这将创建如下所示的输出
安装
$ pip install sphinxcontrib-osexample在 Sphinx 中启用扩展
只需将 sphinxcontrib.examplecode 添加到 conf.py 文件中扩展列表即可。例如
extensions = ['sphinxcontrib.osexample']文档
最终用户的完整文档可以在“docs”文件夹中找到。
您还可以在 Read The Docs 上找到。
贡献
支持
如果您遇到问题，请告诉我们。
许可证
该项目采用 BSD 许可。
关闭
sphinxcontrib-osexample-0.1.1.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | ab05432cb818def8566662cf4d4815d9f18bdf2bd1da386fb3b079fb59857cb9 |
|
| MD5 | 7eefa1b3dc3a4a91aea515d4335ab988 |
|
| BLAKE2b-256 | 4d062625bad796cf45065002b4144e7cef292e6d2ff45a5045b8b826798b2841 |