创建sphinx html文档的多个变体。

sphinx-variations的Python项目详细描述


狮身人面像变化

sphinx扩展,允许项目维护人员根据其对.. only指令的使用创建其文档的多种变体。每个变体都包含一个sphinx标记和一个友好的名称。

如何使用

安装

Sphinx变体在Pypi上提供:

python3 -m pip install sphinx-variations

安装包之后,在sphinx项目的conf.py中列出扩展。

extensions = [..., 'variations']

配置

要为您的文档创建多个变体,可以将用作变体的标记列表插入您的conf.py文件:

variations = [( [tagname], [friendly name] )]

例如:

variations = [('python', 'Python'),
              ('cpp', 'C++')]

上述操作将生成两个文档文本副本,每个副本都位于带有标记名的目录中。静态文件不会在两个变体之间复制,而是在它们之间共享。

模板变量

这个扩展还提供了两个模板变量variationscurrentvariation

variations包含上述指定格式的变体的完整列表,并且currentvariation包含当前变体的元组。

例如,这些变量可用于在文档的不同变体之间创建链接。

许可证

麻省理工学院,见LICENSE

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

推荐PyPI第三方库


热门话题
java如何使用“Wed,01 Jul 2015 17:32:41 EDT”解析字符串   java Storm apache升级(1.0.0到2.0.0)   java类驻留在不同的目录中,而不是包指定的目录。为什么?   将Java中的图像缩放到非常小的维度   java如何通过子文档从自定义方面访问ElasticSearch parentdoc字段   java如何在RationalSoftwareArchitect中使用findbugs?   Java中的事件提升处理   java值被添加到arrayList的所有索引中,而不是在“”时添加到最后一个索引中。正在使用arraylist的add()方法   JFrame中的java JPanel派生类   java如何用循环和异步方法模拟类   java Android阻止可绘制背景超出视图范围   为客户排序Java阵列   java Apache poi如何将工作表设置为枚举位置值属性?   java Rhino在使用自定义类参数调用javascript函数时出错   java格式化日期从年月日到年月日   spring如何修复java。lang.illegalargumentexception在此特定场景中是否尝试创建具有null实体的合并事件?   java如何创建更好的对象