aroberge / docpicture Goto Github PK

Introduce something like

..image:: url or path

to be compatible with reStructuredText.
http://docutils.sourceforge.net/docs/ref/rst/directives.html#images

When calling parsers, unhandled exceptions may occur. It would be better to
trap such exceptions, print the traceback and continue. Note: parsers
included with the standard distribution should take care of potential
errors within their body.

docpicture.view() is meant as an enhancement over the standard Python help.
 Should its name rather be docpicture.help() ... or something else.

ascii art figure (aafigure) is an experimental project for docutils.  It
can already produce quite complex diagrams.  Implementing it means to adapt
the existing code.

When started from the command line, docpicture should behaved as follows:

python docpicture.py or python docpicture.py -h:  displays some usage

python docpicture.py some_file:   processes the file and displays it in the
browser

python docpicture.py some_file -o=output_file:  processes the file and
create an output file rather than displaying it in the browser.

Currently, only the modern-blue style for the uml sequence diagrams
http://www.websequencediagrams.com/
is implemented.  Need to implement all existing styles.  Eventually, will
need to reproduce the same functionality in an independent way.

In the course of creating some uml sequence examples, an error was
generated while using angle brackets <<...>> as per one example on the
website.  Potentially problematic characters should be escaped.

matplotlib has an svg backend; it might be worthwhile to investigate its use.