Source

sphinx-contrib / blockdiag /

Filename Size Date modified Message
..
sphinxcontrib
37 B
1.4 KB
65 B
2.1 KB
83 B
1.4 KB
864 B

blockdiag extension README

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

rendered:

source:

.. blockdiag::

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

Setting

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

Required components

Install

> easy_install sphinxcontrib-blockdiag

Configure Sphinx

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

import os, sys

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

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

Directive

Configuration File Options

Repository

This code is hosted by Bitbucket.

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