Skip to main content

缩略图的 Sphinx 扩展

项目描述

sphinxcontrib-images (以前sphinxcontrib-fancybox )。

Sphinx 文档中的简单缩略图(专注于 HTML)。

特征

  • 在文档 (HTML) 中显示缩略图而不是全尺寸图像。

  • 能够使用 LightBox2 (HTML) 缩放/放大图片。

  • 能够对图片进行分组

  • 下载远程图片并将其保存在缓存中(如果需要)

  • 支持其他格式(latex、epub、... - 回退到图像指令)

  • 易于扩展(只需几行代码即可添加自己的后端)

    • 添加除 LightBox2 之外的其他 HTML“预览”解决方案

    • 为非 HTML 输出添加更好的支持

    • 预处理图像

去做

  • 制作适当的缩略图(缩小图像)

如何安装?

通过 pip 安装:

pip install sphinxcontrib-images

或通过 GitHub:

pip install git+https://github.com/sphinx-contrib/images

接下来,您必须在 Sphinx 项目中为conf.py添加扩展名。

extensions = [
          …
          'sphinxcontrib.images',
          …
          ]

如何使用它?

例子:

.. thumbnail:: picture.png

您还可以覆盖Sphinx 提供的默认图像指令。检查所有配置选项的文档。

问题和建议

如果您有任何建议、补丁、问题 - 请使用 GitHub 问题

下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

sphinxcontrib-images-0.9.4.tar.gz (116.9 kB 查看哈希

已上传 source

内置分布

sphinxcontrib_images-0.9.4-py2.py3-none-any.whl (118.7 kB 查看哈希

已上传 py2 py3