操作系统代码块的sphinx扩展

sphinxcontrib-osexample的Python项目详细描述


Documentation Status

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

这将创建如下输出:

Example how it looks like as generated HTML

安装
$ pip install sphinxcontrib-osexample
在狮身人面像中启用扩展功能

只需将sphinxcontrib.examplecode添加到conf.py文件的扩展名列表中。例如:

extensions=['sphinxcontrib.osexample']

文档

最终用户的完整文档可以在“docs”文件夹中找到。

也可以在Read The Docs

支持

如果你有问题,请告诉我们。

许可证

该项目是根据BSD授权的。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java如何将日期字符串解析为整数变量?   java如何在Spring3+WS2+中使用注释、JibxMarshalling或使用xml配置配置JibxMarshalling和unmarshalling?   安装Oracle Jdeveloper时mac中出现java安装错误。   设置自动保存计时器以在java中定期保存文件(但不使用任何JavaFXAPI)的最佳策略是什么?   模板获取handlebar java中迭代器列表的长度   java如何在特定JAX RS调用中排除对象中的字段?   在Struts 2中抛出NullPointerException的java getText()方法   java比较捐献者和接受者的血型   fedora Java向后兼容性   字符串Java替换多个字符   复制BuffereImage时出现java数组索引错误   并行处理Java 8并行流findFirst   java关闭应用程序后如何离开服务?   Java:Tesseractocr:如何查找单词坐标?