Source

sphinx-contrib / sdedit /

Filename Size Date modified Message
..
doc
sphinxcontrib
535 B
1.4 KB
47 B
3.7 KB
81 B
1.5 KB

sdedit extension README

This is a sphinx extension which render sequence diagrams by using Quick Sequence Diagram Editor (sdedit).

rendered:

source:

.. sequence-diagram::
   :maxwidth: 500
   :linewrap: false
   :threadnumber: true

   actor:Actor
   sphinx:Sphinx[a]
   dot:Graphviz
   sdedit:Quick Sequence Diagram Editor

   actor:sphinx.make html
   sphinx:dot.render_diagram()
   sphinx:sdedit.render_diagram()

Setting

You can get archive file at http://bitbucket.org/shibu/sdeditext_for_sphinx/

Required components

Install

> easy_install sphinxcontrib-sdedit

Configure Sphinx

To enable this extension, add sphinxcontrib.sdedit module to extensions option at :file:`conf.py`.

import os, sys

# Path to the folder where sdedit.py is
# NOTE: not needed if the package is installed in traditional way
# using setup.py or easy_install
sys.path.append(os.path.abspath('/path/to/sphinxcontrib.sdedit'))

# Enabled extensions
extensions = ['sphinxcontrib.sdedit']

# Path to sedit -setup (http://sdedit.sourceforge.net/)
# you can use .jar, .exe, .bat, .sh
sdedit_path = '/path/to/sdedit-3.0.5.jar'

On Windows, you can also use the .exe version of sdedit. The configuration key :confval:`sdedit_path` is required. See also the :ref:`complete list of the configuration keys <config>`.

Directive

Configuration File Options