用于创建子图的Sphinx扩展。
项目描述
sphinx-subfigure
用于创建具有多个图像的图的Sphinx扩展
- 提供了一种简单格式,用于复杂图像布局。
- 完全支持HTML,具有响应式布局,适用于不同屏幕尺寸
- 支持LaTeX,除跨多行的图像外
- 对其他格式具有良好的降级效果。
- 支持图编号和引用。
- 支持通过
alt
文本进行图像子标题。
用法
使用pip install sphinx-subfigure
安装sphinx-subfigure
,然后将sphinx_subfigure
添加到您的conf.py
文件的extensions
变量中
extensions = ["sphinx_subfigure"]
numfig = True # optional
现在将一个subfigure
指令添加到您的文档中
.. subfigure:: AA|BC
:layout-sm: A|B|C
:subcaptions: above
:name: myfigure
:class-grid: outline
.. image:: imageA.png
:alt: Image A
.. image:: imageB.png
:alt: Image B
.. image:: imageC.png
:alt: Image C
Figure Caption
- 每个图像都会自动分配一个区域标识符(A,B,C等)。
- 布局是通过将区域组合成一个网格来形成的,行由
|
分隔。 - 每个区域必须恰好用于一次布局,并形成一个单独的长方形。
- 可以使用
.
指定“空”区域。 - 可以通过定义
:layout-sm:
、:layout-lg:
、:layout-xl:
等,为不同屏幕尺寸定义额外的布局(仅限HTML)。
项目详情
下载文件
下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。
源代码分发
sphinx_subfigure-0.2.4.tar.gz (576.2 kB 查看哈希值)