Adds FTP mode support for PlantUML

danwos commented 3 years ago

Allows to use the FTP mode from PlantUML. This avoids the startup of the JAVA RTE for each diagram generation, which may speed up the overall build process if many files need to be generated.

It is the first shot, so it may not be perfect.

Content:

FTP mode feature
Tests for FTP mode
Updated docs / README for FTP mode config vars
Fixed test case. At least on my system it failed. Maybe because of a new Sphinx version and there a changed HTML output.

Known problems:

Output format svg is not supported, because this format needs to generate svg and png. But the PlantUML FTP server can only handle one fix format after start up. So we would need to spawn two instances of it. Doable, but I'm not sure if this extra level of complexity is really needed only for "svg" output. svg_img and svg_obj are supported!
For tests I needed to implement time.sleep(0.5) in some situations. Otherwise start up and termination of the server may get in conflict, if tests are fired to quickly for the system. But it doesn't affect the overall diagram generation time. So in worst case it costs <=1 sec of extra build time.
Not tested on windows or mac!

Fixes #44

danwos commented 10 months ago

Ok, I thought with the batch mode the FTP solution is not planned to get implemented. But if it is still on the ToDo list, I will update it and fix the conflicts. Just let me know :)

yuja commented 10 months ago

I think the current batch option is good enough to get rid of jvm overhead. @jdillard do you have a use case where you want to use the FTP mode?

jdillard commented 10 months ago

Totally fine with me! I was just poking around and forgot to look when the PR was created.

danwos commented 10 months ago

Ok, I close this PR as there is no need to implement it :)

sphinx-contrib / plantuml

Adds FTP mode support for PlantUML #48