plantweb.render
¶Plantweb main rendering module.
render_file()
:
Render given PlantUML, Graphviz or DITAA file.render()
:
Render given PlantUML, Graphviz or DITAA content.render_cached()
:
Render given content in the PlantUML server or fetch it from cache.determine_engine()
:
Determine the engine used in the given content.plantweb.render.
render_file
(infile, outfile=None, renderopts=None, cacheopts=None)¶Render given PlantUML, Graphviz or DITAA file.
Parameters: |
|
---|---|
Returns: | Path to output file. |
Return type: |
plantweb.render.
render
(content, engine=None, format=None, server=None, cacheopts=None)¶Render given PlantUML, Graphviz or DITAA content.
Parameters: |
|
---|---|
Returns: | A tuple of |
Return type: |
plantweb.render.
render_cached
(server, format, content, use_cache=None, cache_dir=None)¶Render given content in the PlantUML server or fetch it from cache.
Parameters: |
|
---|---|
Returns: | A tuple of |
Return type: |
plantweb.render.
determine_engine
(content)¶Determine the engine used in the given content.
The engine is determined by the @startXXX
used at the beginning of the
file. Possible values are:
@startuml --> plantuml
@startdot --> graphviz
@startditaa --> ditaa
Parameters: | content (str) – Content to analyze. |
---|---|
Returns: | The name of the engine found, or None. |
Return type: | str |