Skip to main content

Sphinx extension that integrates www.websequencediagrams.com

Project description

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

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

sphinx-websequencediagrams-0.3.4.tar.gz (4.5 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page