README.md

sphinx-ditaa

This adds a basic ditaa builder for sphinx

Installation

pip install -e .

install ditaa command

Using the Ditaa with Sphinx

add sphinxcontrib.ditaa to the extensions list in conf.py:

extensions = [
   ... other extensions here ...
   sphinxcontrib.ditaa
   ]

# ditaa command. should be install ditaa
ditaa = 'ditaa'  # ditaa command
# ditaa_args = ''  # custom ditaa args

write ditaa code in rst file.

    .. ditaa::
      +--------+   +-------+    +-------+
      |        | --+ ditaa +--> |       |
      |  Text  |   +-------+    |diagram|
      |Document|   |!magic!|    |       |
      |     {d}|   |       |    |       |
      +---+----+   +-------+    +-------+
          :                         ^
          |       Lots of work      |
          +-------------------------+

** Python 3 compatible **