Sphinx¶
此扩展添加了 aafig
指令自动选择要根据 Sphinx 用于生成文档的编写器。
快速示例¶
此来源::
.. aafig::
:aspect: 60
:scale: 150
:proportional:
:textual:
+-------+ +-----------+
| Hello +-------->+ aafigure! |
+-------+ +-----------+
呈现为:
在中启用扩展模块 Sphinx¶
只需添加 aafigure.sphinxext
中的扩展名列表中 conf.py
文件。例如::
extensions = ['aafigure.sphinxext']
选项¶
这个 aafig
指令具有以下选项:
:scale: <int>
放大或缩小图像:line_width: <float>
更改行(当前仅限SVG):foreground: <str>
foreground color in the form#rgb
or#rrggbb
:background: <str>
表单中的背景色#rgb
或#rrggbb
( not 用于SVG输出):fill: <str>
fill color in the form#rgb
or#rrggbb
:aspect: <int>
更改纵横比。实际上,是图像的宽度乘以此百分比。默认设置1
当形状在水平或垂直方向绘制时必须具有相同的外观时,此选项非常有用。然而,:aspect: 50
看起来更像最初的ASCII,甚至更小的系数可能对时序图等有用。但存在文本被裁剪或被绘制在其旁边的对象上的风险。拉伸是在画箭头或圆圈之前进行的,这样它们仍然很好看。
:proportional:
使用比例字体而不是单倍行距的字体:textual:
更喜欢检测文本而不是填充:rounded:
对于许多对角线使用圆弧而不是直线:scale:
和:aspect:
选项使用百分比指定(不带 % 签名),以匹配 reStructuredText 图像指令。
配置¶
添加了一些配置选项(当然,都是可选的;) Sphinx 因此您可以将它们设置在 conf.py
文件:
aafig_format
<dict>:用于不同构建器的图像格式。全
latex
,html
和text
构建器是受支持的,如果其他构建器正确地处理图像(如果一个图像可以呈现适合该构建器的图像格式),那么只需在这里添加正确的格式映射,添加对其他构建器的支持应该是微不足道的。一种特殊格式
None
是受支持的,这意味着不使用aFigure来渲染图像,只需在结果文档中显示原始的ASCII图片(使用文字块)。这几乎只对文本构建器有用。您可以使用DICT指定格式生成器映射。例如::
aafig_format = dict(latex='pdf', html='svg', text=None)
这些是实际的默认设置。
aafig_default_options
<dict>:默认aafigure选项。默认情况下使用这些选项,除非在
aafig
指令。如果未指定此选项,则使用默认的aafigure选项。您可以提供部分默认设置,例如::aafig_default_options = dict(scale=150, aspect=50, proportional=True)
请注意,在本例中,
aspec
和scale
选项被指定为浮点数,就像最初由afigure所做的那样。
TODO¶
添加颜色验证
fill
,background
和foreground
选择。增列
aa
用于轻松嵌入小图像(如箭头)的角色。
历史¶
此扩展曾经单独提供: sphinxcontrib-aafig website.