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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3fb1096f10f147715a5b643e1a072dc7c5fda81c3d974a6dd4c6c315fece4db |
|
MD5 | 11ed9705fbb03fcf0cfc9a7a84f21657 |
|
BLAKE2b-256 | 867bb3e7a40b24c5cd0a3ee6889179b1fdf7b6499c0fe2fd91f3ab60c37fb69b |
Close
Hashes for sphinx_websequencediagrams-0.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c54775fc3591de4ac13bdb183705918fa21b03ebec6c31bccb4440de99fb13d |
|
MD5 | 944340b20015740cec51188f01776f47 |
|
BLAKE2b-256 | 4f7c0abe525235e88dc6553f5d40a0eee84d8ae631d1bc68d4cc3b68175a67cc |