狮身人面像扩展器
sphinxcontrib-asciiart的Python项目详细描述
http://packages.python.org/sphinxcontrib-asciiart
一个Sphinx扩展名,用于转换Sphinx文档中的ascii艺术色序列 转换成彩色的HTML或.png或其他输出。在
安装
此扩展可以从Python包索引安装:
pip install sphinxcontrib-asciiart
使用
只需将sphinxcontrib.asciiart添加到 conf.py文件。例如:
^{pr2}$然后使用asciiart块包含ascii艺术代码:
.. asciiart:: ?[31m :. ,..?[0m ?[31m .' :~.':_.,?[0m ?[31m .' ::.::'.'?[0m ?[31m : ::' .:?[0m ?[31m `.: .: .:/?[0m ?[31m `::--.:'.::'?[0m ?[31m |. _:===-'?[0m ?[32m / /?[0m ?[32m ,---.---. __,','?[0m ?[32m (~`. \ ) )','.,---..?[0m ?[32m `v`\ | ,' .-'.:,'_____ `.?[0m ?[32m )|/.-~.--~~--. ~~~-. \?[0m ?[32m _/-'_.-~ ""---.._`.|?[0m ?[32m _.-~~_.-~ ""'?[0m ?[32m _..--~~_.(~~?[0m ?[32m __...---~~~_..--~~?[0m ?[32m'___...---~~~?[0m
然后它将被呈现为一个彩色的文本块或图像。展示 pypi网页的内容,我删除颜色:
:. ,.. .' :~.':_., .' ::.::'.' : ::' .: `.: .: .:/ `::--.:'.::' |. _:===-' / / ,---.---. __,',' (~`. \ ) )','.,---.. `v`\ | ,' .-'.:,'_____ `. )|/.-~.--~~--. ~~~-. \ _/-'_.-~ ""---.._`.| _.-~~_.-~ ""' _..--~~_.(~~ __...---~~~_..--~~ ,'___...---~~~
选项
sphinxcontrib asciiart提供了丰富的选项来保护输出。你可以 配置全局设置时,也可以只更改一个的行为 ascii艺术字块。在
当全局设置和基于文本块的设置更改时,或者如果 如果文本块的内容发生更改,则会重新生成目标图像 即使已经有目标图像缓存。在
全局设置
首先,应该在配置文件 要启用ASCINXCONTRIB,请执行以下操作:
extensions = ['sphinxcontrib-asciiart']
然后,您可以配置许多其他全局配置:
ascii艺术输出格式
ascii_art_output_format给出ascii art块的输出格式。我们使用 用于控制mt的生成输出的后缀。默认值如下 你可以在你的配置文件格式如下:
ascii_art_output_format = dict(html='.html', latex='.png', text='.txt')
这意味着当您构建html输出时,ascii艺术块被构建为html 然后链接到整个文档。当你建立乳胶输出, 生成纯文本输出时,它是.png文件和.txt文件。.html格式是 仅当生成html时才支持html。在
除了tht.html和.txt格式,我们还支持许多其他类型的输出 格式:
bmp dib eps gif icns ico im jpg jpeg msp pcx png ppm sgi spider tga tiff webp xbm palm pdf xv bufr fits grib hdf5 mpeg
ascii艺术图像字体
当我们呈现图像而不是“.html”和“.txt”时,我们使用哪种字体 使用,这是一个字体名称的列表,我们想用它来呈现ascii艺术。这个 前一个优先使用。默认值为:
ascii_art_image_font = 'NSimSun, simsun, monospace'
ascii图片字体大小
当我们呈现图像而不是“.html”和“.txt”时,我们需要的字体大小 要使用,它是一个整数,默认值是:
ascii_art_image_fontsize = 14
块特定设置
- “spacing”:int,每行之间的空格。默认值为-1。在
- “font”:str,我们要用来呈现ascii艺术的字体名称列表。前面的一个优先使用。在
- “fontsize”:int,我们要用来呈现ascii艺术的字体大小。在
例如:
.. asciiart:: :font: simsun, monospace, "Times new roman" :fontsize: 14 :spacing: 0 .· .·. ?[1;35m/╲ /|?[0m ·?[1;35m│ \ ╱ |?[0m ?[1;35m\-.___ / \ \/ / /?[0m ?[1;35m\ __ ╲ ?[1;33m.,.?[1;35m| ╱__?[0m ?[1;35m╱ 乁 ?[1;33m'\|)?[1;35m╱ ̄ ╲?[0m ?[1;35m-<`︶╲__╱ ?[1;33m︶?[1;35m╲ ╲ \?[0m ?[35m ̄ ̄ / / ╱﹀乀 \│?[0m ?[1;35m╲ ' /?[1;30m╲ ·╲/?[0m ?[1;35m\| / ?[1;30m\ ; `?[0m ?[1;35m\/ ?[1;30m\ ·,?[0m .----/?[1;35m ′ ?[1;30m︳ ·__,?[0m
变更日志
1.0.0初始上传。在
1.0.1如果图像属性中没有高度、宽度和比例选项,则自动添加img[“height”]以保持原始高度x宽度,以避免在pdf中放大。我们希望在PDF中显示原始字体。在
1.0.2调整html输出的方框阴影。在
1.0.3错误修复:如果已经有.png,则不插入img[“height”]。在
1.0.4错误修复:1)错误配置后缀可能导致崩溃。2) 有 偶尔出现分析错误。在
1.0.5小错误修复。在
1.0.6仅当全局设置和 基于文本块的设置是更改的,或者当文本的内容 改变块,即使有目标也会重建目标图像 图像缓存已经存在。在
1.0.7错误修复:bg_洋红色可能无法解析。 1.0.8文本输出不包括选项。在
- 项目
标签: