Python
Switch branches/tags
Nothing to show
Latest commit 0ed4910 Feb 4, 2017 @baloo committed on GitHub Merge pull request #5 from daoiqi/master
add setup.py
Permalink
Failed to load latest commit information.
sphinx rename top dir. Feb 3, 2017
README.md rename top dir. Feb 3, 2017
setup.py rename top dir. Feb 3, 2017

README.md

sphinx-ditaa

This adds a basic ditaa builder for sphinx

Installation

pip install sphinx-ditaa

install ditaa command

Using the Ditaa with Sphinx

add sphinx.ext.ditaa to the extensions list in conf.py:

extensions = [
   ... other extensions here ...
   sphinx.ext.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      |
          +-------------------------+