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

Note

All filepaths supplied to the :file: option are relative to your documentation’s source directory

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinx-websequencediagrams, version 0.3.4
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_websequencediagrams-0.3.4-py3-none-any.whl (5.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sphinx-websequencediagrams-0.3.4.tar.gz (4.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page