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 git+https://github.com/MaxwellGBrown/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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for sphinx_websequencediagrams-0.3.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5d800ed7b79bad6bacf5580f6314067134be9d6d6101d4569f02914234c583f |
|
MD5 | 095c4e7800e69aa2686ffbdaec01ccc6 |
|
BLAKE2b-256 | 9f13cd47861de91d1f89fae6aa345db35225bf1a37d38abe7e8dfe136a3de495 |