狮身人面像扩展包括绘图.io使用HTML5嵌入的文件
sphinxcontrib-drawio-html的Python项目详细描述
SphinxControl绘图html
Sphinx扩展来添加要包含的drawio-html
指令
绘图.io将图表放入生成的HTML文档中。在
Important:这是一个alpha扩展,因此可能无法工作或 100%满足您的需求。请参阅已知问题部分。在
安装
python3 -m pip install sphinxcontrib-drawio-html
或使用pipenv
- 在你的狮身人面像配置中:
extensions=["sphinxdrawio.drawio_html"]
选项
此时不支持conf.py
中的选项。在
使用
^{pr2}$已知问题
- 此扩展仅使用readthedocs主题进行测试。它使用jQuery和字体awesome 这与rtd主题有关,如果没有主题,它将不可能工作。在
- 只创建HTML转换器,这意味着不太可能支持Latex和PDF 工作。PDF和其他构建器根本就没有尝试过。在
- 自定义样式覆盖是间歇性工作的。一些具有HTML/CSS专业知识的人可能会 帮助排除故障。在
愿望清单
- 在中提供默认值配置文件对于扩展,隐藏nav和force name,以便 可以决定他们显示文件的基本方式。目前必须在 每个文件。在
- 在中更改内容区域以接受每页的一些rst绘图.io这样它就可以
可以很容易地在图表中穿插。演示文稿也可以更改为显示
该部分的图表和内容。目前唯一的选择是增加倍数
指令。
在.. drawio-html:: example.drawio :expanded: :hide-nav: :force-name: style-overrides class-diagram: lorum ipsum dorum sequence-diagram: nice orderly work.
- 添加一些测试。甚至不知道其他斯芬克斯扩展是如何测试的。在
- 全屏显示图表。在
- 提供的注释可以添加到每个图表中,提供布局选项来放置 右侧或底部的注释。在
如果你看到了什么文件问题,或者最好打开一个拉取请求:-)
致谢
- 本文的灵感来自于这里的工作:https://github.com/Modelmat/sphinxcontrib-drawio
- HTML/CSS experience由https://github.com/BabyManisha慷慨提供
- 项目
标签: