Sphinx extension that integrates www.websequencediagrams.com
Project description
A Sphinx Directive for creating Sequence Diagrams using www.websequencediagrams.com.
Setup
Install the package
pip install sphinx-websequencediagrams
Update your sphinx conf.py to include the package
extensions = ["sphinx_websequencediagrams"]
Use the sequencediagram directive in your RST!
.. sequencediagram: A->B: A to B B->A: B to A
Usage
Visit www.websequencediagrams.com to see how to compose a sequence diagram!
Sequence Diagram from text
To compose a sequence diagram, use the .. sequencediagram:: directive.
.. sequencediagram:: A -> B B -> A
Sequence Diagram from file
The contents of a .. sequencediagram:: directive can also be supplied via a file.
# source/index.rst .. sequencediagram:: :file: a_to_b.txt
# source/a_to_b.txt A -> B B -> A
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sphinx-websequencediagrams-0.3.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7cd61410061b729149e4c3136b452a4700b653c46b8ed407a34c9ec4abba4e8e |
|
MD5 | 6aa255da4bd8acf18c73684928c40947 |
|
BLAKE2b-256 | 451362875794bb26862f46c37756ab86056890e1a55183d8684f541b3f3db357 |
Close
Hashes for sphinx_websequencediagrams-0.3.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82e352bc3123a2933dc01fe5883dfd99bbf6cbaecef22af294a17e3048147df0 |
|
MD5 | 0ce2b38bbcc2433e8fee37f989762238 |
|
BLAKE2b-256 | 0ee144ebb1a6aafb385a67cabbd5dbdf394a25bd56635cb6c9dd55b278c95ae4 |