Skip to main content
Ctrl+K
mochada_kit mochada_kit
  • User guide
  • Contributing
  • API reference
  • Changelog
  • GitHub
  • User guide
  • Contributing
  • API reference
  • Changelog
  • GitHub

Section Navigation

  • cli
    • cli
  • config
    • read_config
    • write_config
  • hdf5_metadata_tools
    • get_ds_dictionaries
    • nested_set
    • write_puml_code_for_hdf5_metadata
  • running
    • run_all_gallery_puml_code
    • run_plantuml_code
  • tables
    • copy_theme_to_local_folder
    • get_lines_from_keys
    • handle_paths
    • write_chada_tables_plantuml
    • write_chada_tables_single_plantuml
    • write_chada_tables_whole_plantuml
  • API reference
  • running
  • run_all_gallery_puml_code

run_all_gallery_puml_code#

mochada_kit.running.run_all_gallery_puml_code(output_type='-tsvg')#

Run all the plantuml code in gallery/puml_code against plantuml.jar generating .svg diagrams, which are stored in gallery.

To save the diagrams as .png files, change output_type to “-tpng”.

Parameters:
output_typeSTR, optional

String specifying the output type flag to be passed to plantuml.jar. All options can be seen under this link: https://plantuml.com/command-line#458de91d76a8569c.

Common values are:

  • “-tsvg” –> svg image

  • “-tpng” –> png image

The default is “-tsvg”.

previous

running

next

run_plantuml_code

On this page
  • run_all_gallery_puml_code()
Show Source

© Copyright 2024-2024, The mochada_kit Contributors.

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.0.