Sphinx contribution Ditaa

Simple Ditaa builder for sphinx, for python 3.

Requirements

Sphinx Ditaa requires Python 3.5, native dependency Ditaa and python packages.

• Python >=3.5
• pip3 pip >=9.0.0
• Sphinx >=1.0.7
• Ditaa >=0.8

Installation

• Install native dependency, installation depends on your OS and/or your distribution, example for Debian:

sudo apt-get install ditaa
sudo apt-get install python3
sudo apt-get install python3-pip

sudo pip3 install sphinx

• Install Sphinx contribution:

pip3 install .

Using the Ditaa with Sphinx

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

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

ditaa = 'ditaa'    # ditaa command
ditaa_args = ''    # custom ditaa args

Write ditaa code in rst documentation:

.. ditaa::

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