Skip to main content

sphinx-websequencediagrams

A Sphinx Directive for creating Sequence Diagrams using www.websequencediagrams.com.

Setup

  1. Install the package

    pip install sphinx-websequencediagrams
  2. Update your sphinx conf.py to include the package

    extensions = ["sphinx_websequencediagrams"]
  3. 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

Metadata

Release files for sphinx-websequencediagrams 0.3.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-websequencediagrams 0.3.4
File Size Uploaded
sphinx-websequencediagrams-0.3.4.tar.gz 4.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-websequencediagrams 0.3.4
File Interpreter ABI Platform
sphinx_websequencediagrams-0.3.4-py3-none-any.whl Python 3 none any Details

Total release size: 10.1 kB

Release files / sphinx-websequencediagrams-0.3.4.tar.gz

Download URL sphinx-websequencediagrams-0.3.4.tar.gz
Size 4.5 kB
Tags Source
SHA-256 checksum
How to use checksums
7cd61410061b729149e4c3136b452a4700b653c46b8ed407a34c9ec4abba4e8e
BLAKE2b-256 checksum
How to use checksums
451362875794bb26862f46c37756ab86056890e1a55183d8684f541b3f3db357
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.8.1

Release files / sphinx_websequencediagrams-0.3.4-py3-none-any.whl

Download URL sphinx_websequencediagrams-0.3.4-py3-none-any.whl
Size 5.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
82e352bc3123a2933dc01fe5883dfd99bbf6cbaecef22af294a17e3048147df0
BLAKE2b-256 checksum
How to use checksums
0ee144ebb1a6aafb385a67cabbd5dbdf394a25bd56635cb6c9dd55b278c95ae4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.8.1

Release history Release notifications | RSS feed

This release

0.3.4 This release

2 release files

0.3.3

2 release files

0.3.2

1 release file

0.3.1

1 release file

0.3

1 release file

0.2

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page