GitXplorerGitXplorer
b

sphinx-ditaa

public
11 stars
25 forks
2 issues

Commits

List of commits on branch master.
Unverified
edbdc3afc95551fd0f794255e377fc1a1817ff84

Merge pull request #13 from fathyb/patch-1

bbaloo committed 7 years ago
Unverified
9c87dfde0308e07afb73010a00af38253f9e1cc4

Assume all string are unicode in Python 3

ffathyb committed 7 years ago
Unverified
e4a43ea56651b096111076f436ac1d7b330e9051

Merge pull request #12 from jbar/master

bbaloo committed 7 years ago
Unverified
451febd16623085830e42fc24a3eef16ac83c0f8

fix UnicodeEncodeError when loading utf-8 ditaa file with python2

committed 7 years ago
Unverified
de4f423e2c2fbbdb0509fcb272a39938628ae372

Fixup date and author

committed 7 years ago
Unverified
a685c95a8525f2be4884c656df05d2007b9fd471

Adds license

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