Sphinx扩展,集成了www.websequencediagrams.com
sphinx-websequencediagrams的Python项目详细描述
用于使用www.websequencediagrams.com创建序列图的sphinx指令。
设置
安装软件包
pip install sphinx-websequencediagrams
更新sphinx conf.py以包含包
extensions = ["sphinx_websequencediagrams"]
在rst中使用sequencediagram指令!
.. sequencediagram: A->B: A to B B->A: B to A
用法
访问www.websequencediagrams.com查看如何组成序列图!
文本序列图
要组合序列图,请使用.. sequencediagram::指令。
.. sequencediagram:: A -> B B -> A
文件
中的序列图.. sequencediagram::指令的内容也可以通过文件提供。
# source/index.rst .. sequencediagram:: :file: a_to_b.txt
# source/a_to_b.txt A -> B B -> A
注意
提供给:file:选项的所有文件路径都与文档的源目录相关