狮身人面像扩展包括绘图.io使用HTML5嵌入的文件

sphinxcontrib-drawio-html的Python项目详细描述


SphinxControl绘图html

Sphinx扩展来添加要包含的drawio-html指令 绘图.io将图表放入生成的HTML文档中。在

Important:这是一个alpha扩展,因此可能无法工作或 100%满足您的需求。请参阅已知问题部分。在

安装

  1. python3 -m pip install sphinxcontrib-drawio-html或使用pipenv
  2. 在你的狮身人面像配置中:
extensions=["sphinxdrawio.drawio_html"]

选项

此时不支持conf.py中的选项。在

使用

^{pr2}$

已知问题

  1. 此扩展仅使用readthedocs主题进行测试。它使用jQuery和字体awesome 这与rtd主题有关,如果没有主题,它将不可能工作。在
  2. 只创建HTML转换器,这意味着不太可能支持Latex和PDF 工作。PDF和其他构建器根本就没有尝试过。在
  3. 自定义样式覆盖是间歇性工作的。一些具有HTML/CSS专业知识的人可能会 帮助排除故障。在

愿望清单

  1. 在中提供默认值配置文件对于扩展,隐藏nav和force name,以便 可以决定他们显示文件的基本方式。目前必须在 每个文件。在
  2. 在中更改内容区域以接受每页的一些rst绘图.io这样它就可以 可以很容易地在图表中穿插。演示文稿也可以更改为显示 该部分的图表和内容。目前唯一的选择是增加倍数 指令。
    .. drawio-html:: example.drawio
        :expanded:
        :hide-nav:
        :force-name:
    
        style-overrides
    
        class-diagram:
            lorum ipsum dorum
    
        sequence-diagram:
            nice orderly work.
    
    
  3. 添加一些测试。甚至不知道其他斯芬克斯扩展是如何测试的。在
  4. 全屏显示图表。在
  5. 提供的注释可以添加到每个图表中,提供布局选项来放置 右侧或底部的注释。在

如果你看到了什么文件问题,或者最好打开一个拉取请求:-)

致谢

  1. 本文的灵感来自于这里的工作:https://github.com/Modelmat/sphinxcontrib-drawio
  2. HTML/CSS experience由https://github.com/BabyManisha慷慨提供

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java JNI和取消异步任务   java整数n作为List<String>的第二个参数传递。子列表(fromIndex,toIndex),但是stacktrace说toIndex在Kotlin中是n+2   如何在Java中正确嵌套多个ArrayList/Maps?   在嵌套条件语句中比较数组中的值时,java List没有打印正确的值   从CRON作业运行java代码   JRE使用jvisualvm检测到java致命错误   java将字符添加到BufferedReader中   带有枚举的java单例与带有双重检查锁定的单例   Java中的编译器构造基类的更改会影响子类的字节码吗?   Java作为Windows服务用户数据路径   java clone():ArrayList。克隆人()我认为它是一个肤浅的复制品   在jfilechooser多文件选择器启用中打开对话框后,java文件将显示所选文件   java在常用的操作方法中使用反射可以吗?   java ReloadableResourceBundleMessageSource。getMessage()不使用我给它的参数