Source

sphinx-contrib / actdiag /

Filename Size Date modified Message
..
sphinxcontrib
37 B
1.4 KB
65 B
2.2 KB
83 B
1.5 KB
868 B

actdiag extension README

This is a sphinx extension which render block diagrams by using actdiag .

rendered:

source:

.. actdiag::

   diagram {
     A -> B -> C -> D;

     lane {
       A; B;
     }
     lane {
       C; D;
     }
   }

Setting

You can get archive file at http://bitbucket.org/birkenfeld/sphinx-contrib/

Required components

Install

> easy_install sphinxcontrib-actdiag

Configure Sphinx

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

import os, sys

# Path to the folder where actdiag.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.actdiag'))

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

Directive

Configuration File Options

Repository

This code is hosted by Bitbucket.

http://bitbucket.org/birkenfeld/sphinx-contrib/