Sphinx扩展,用于添加可选代码块作为可选选项卡

sphinx-code-tabs的Python项目详细描述


Latest VersionLicense: UnlicenseDocumentation

这是一个Sphinx扩展,它添加了一个指令code-tabs,它创建了一个 导航栏位于多个可选代码块上方,允许用户切换 他们之间。在

例如,可以用多种语言在多个 平台,或源代码和渲染。在

有关可视化示例,请参见Documentation#Usage。。在

安装

pip install sphinx_code_tabs

要在sphinx中启用扩展,只需在 conf.pyextensions列表:

^{pr2}$

使用

通过启用扩展,您可以访问code-tabs指令,该指令 声明代码块替代项的笔记本。在

有关可视化示例,请参见Documentation#Usage。。在

必须使用code-tab指令创建各个选项卡,该指令 从code-block派生并接受其所有参数:

..code-tabs::    ..code-tab:: bash
        :title: bash

        echo "Hello, World!"

    ..code-tab:: c
        :title: C/C++
        :emphasize-lines: 2

        #include <stdio.h>
        int main() { printf("Hello, world!\n"); }

    ..code-tab:: python
        :title: python

        print("Hello, world!")

计划的变更

这个项目刚刚开始。下一个版本的计划特性(这可能是 最初包括向后不兼容的更改!)公司名称:

  • prerender navbar和CSS“hidden”类,这样布局就不会改变 页面重新加载期间
  • 添加将几个选项卡小部件组合在一起的机制,以便选择 保持同步(这意味着对特定语言感兴趣的用户不会 每一篇文章都有较长的语言片段)
  • 采用“标题”属性而不是使用我们自己的“标题”
  • 重用“代码块”,而不是引入我们自己的“代码选项卡”(?)在
  • 允许除代码块以外的制表符(可能)

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

推荐PyPI第三方库


热门话题
在ElasticSearch中将SearchHit转换为Java对象   第三方库类的java重写XmlAdapter   java如何使用动画类获得平滑的动画效果?   Java PDFBox如果文本内容超过PDF的第一页,如何添加新页面?   Java二叉搜索树u根到最近叶的距离   java什么是diff Scanner和BufferedReader   java如何设计不生成并行数组的程序   java多次声明变量会降低执行速度吗?   java如何使用JXLAPI读取下拉列表的值   多线程为什么自定义阻塞队列在Java中不是线程安全的   java在一个变量中每输入1000个单位,就从另一个变量中减去1?   java Mapstruct通用映射器   Java中的类能否确定它是否已被修改?   java如何在MogoOperations聚合函数中定义输出类型?