跳转到主要内容

Sphinx扩展,用于创建响应式图片。

项目描述

sphinxext-photofinish

Photofinish是Sphinx的一个扩展,用于在Sphinx网站上创建响应式图片。这有几个好处

  • 对于不需要高分辨率版本的浏览器和设备,带宽成本更低
  • 对于高分辨率设备,有更高分辨率的图片

Photofinish可以显著增加Sphinx网站的加载时间。

安装

python -m pip install sphinxext-photofinish

用法

只需将sphinxext-photofinish添加到您的conf.py中的扩展列表中。

extensions = [
    "sphinxext.photofinish",
]

配置

Photofinish为conf.py添加了几个可选配置的选项

max_viewport_width - 这是文档中图片的最大“可视”大小。通常,它设置为body的宽度。响应式图片生成的大小是此值的两倍。默认值是1000。

width_min - 生成图片的最小宽度。默认值是500。

width_step - 生成图片时迭代的分辨率。例如:500、800、1100。默认值是300。

photofinish_ci_only - 是否仅在设置CI环境变量时运行此扩展?默认值是False。

支持者