概述
Sphinxcontrib-mscgen是基于Sphinx用于绘制消息序列图的一个工具,因此,在使用Sphinxcontrib-mscgen之前,需要先安装Sphinx,感兴趣的朋友可以可以看下笔者之前发布的Sphinx环境搭建和项目构建的文档,这里不过多描述了。
安装Sphinxcontrib-mscgen
- 创建一个虚拟环境。
python -m venv .venv
- 安装Sphinxcontrib-mscgen。
pip install sphinxcontrib-mscgen
- 创建一个Sphinx项目,可以参考快速构建第一个Sphinx项目。
- 打开
docs/soucre/conf.py
文件,找到extensions
,添加Sphinxcontrib-mscgen扩展,如下图:
- 打开
docs/soucre/index.rst
文件,添加消息序列图相关代码:
.. msc::
hscale = "0.5";
a,b,c;
a->b [ label = "ab()" ] ;
b->c [ label = "bc(TRUE)"];
c=>c [ label = "process()" ];
- 运行
make html
编译,打开docs/build/html/index.html
在您的浏览器中。您应该会看到类似这样的内容:.