GitXplorerGitXplorer
b

sphinx-ditaa

public
11 stars
25 forks
2 issues

Commits

List of commits on branch master.
Unverified
c68f600a1f8b490057c4b8329f3f94e7d6e4d2fb

Update README.md

bbaloo committed 7 years ago
Unverified
339426d99600b8ab0fce3455fab395af5bb8165b

Merge pull request #9 from tchaikov/wip-remove-sphinx.ext.ditaa

bbaloo committed 7 years ago
Unverified
a188aedb70515ca4a28537349330c80602d93331

Merge pull request #8 from tchaikov/master

bbaloo committed 7 years ago
Unverified
5c781f06323bef9294a09b989679343442b308d1

nuke the copy of sphinx.ext.ditaa

ttchaikov committed 7 years ago
Unverified
baad53e5850ba7b93beb72491b93ea01fd9040b4

do not print list using warn()

ttchaikov committed 7 years ago
Unverified
78bfd6abc1932bd64f77378b607ebd9233eb57e0

Merge pull request #6 from w-vi/master

bbaloo committed 7 years ago

README

The README file for this repository.

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 **