创建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++')]
上述操作将生成两个文档文本副本,每个副本都位于带有标记名的目录中。静态文件不会在两个变体之间复制,而是在它们之间共享。
模板变量
这个扩展还提供了两个模板变量variations
和currentvariation
。
variations
包含上述指定格式的变体的完整列表,并且currentvariation
包含当前变体的元组。
例如,这些变量可用于在文档的不同变体之间创建链接。
许可证
麻省理工学院,见LICENSE
。