创建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如何定制springdata存储库方法名称?   html有没有办法将java应用程序或JApplet嵌入到网站中?   Jackson ObjectMapper将java从字符串序列化为JSON作为namevalue   java刷新JTable?   用Java程序分发用JavaDB制作的数据库   java Android如何启动新活动   当集合大小超过500.000时,java的处理速度会显著降低   在java的分层目录中的多个目录中查找相同的文件   java如何将ArrayList数据插入数据库   java如何修改此代码,使其时间复杂度为o(logn)或o(n),而不是o(n^2)   java面板(SimplePanel)中仅显示图像的前1/3(大约),   jakarta ee Java Bean和企业Java Bean之间的区别?   创建AWS Cloudfront自签名URL(java sdk)时出现amazon web服务错误   基于Jersey和Jackson查询参数的java动态属性过滤