操作系统代码块的sphinx扩展
sphinxcontrib-osexample的Python项目详细描述
oseSphinx的示例扩展
这是谢尔盖·多姆科夫斯基为狮身人面像设计的{a2}叉子。
关于
这是一个简单的扩展,当呈现为html时,它将折叠多个 在单个块中包含不同操作系统管理示例的代码块 可以用按钮从一个切换到另一个。
它用于显示包管理器示例。 (例如,apt安装或dnf安装)。
此扩展添加了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
在狮身人面像中启用扩展功能
只需将sphinxcontrib.examplecode添加到conf.py文件的扩展名列表中。例如:
extensions=['sphinxcontrib.osexample']
在狮身人面像中启用扩展功能
只需将sphinxcontrib.examplecode添加到conf.py文件的扩展名列表中。例如:
extensions=['sphinxcontrib.osexample']
支持
如果你有问题,请告诉我们。
许可证
该项目是根据BSD授权的。