iota2.common.debug_utils

Functions

file_search_and(PathToFolder, AllPath, *names)

search all files in a folder or sub folder which contains all names in their name

gen_html_logging_pages(config_file, ...)

gen_rst_pages(config_file, rst_source_dir, ...)

get_config_file(configfile, rst_dir)

get_cont_file_from_config(configfile, ...)

get_cont_path_from_config(configfile, ...)

get_env_informations(tmp_dir, rst_source_dir)

get_locale(path)

get_log_file(logfile)

get_log_info(path, configfile, logfile)

get_output_tree(path_to_draw)

get_package_version(path)

get_tasks_status_rst(svg_status_files, rst_dir)

index_logging(rst_source_dir, pages)

generate iota2 index.rst dedicated to logs

run(cmd[, desc, env, logger])

Launch a system command and raise an execption if fail

set_iota2_tasks_figure_size(html_page)

the svg figure size seems to be configurable, like done at https://github.com/pymedphys/pymedphys/blob/f4d404fa1cf3f551c4aa80ef27438f418c61a436/docs/conf.py by using the setup() method in sphinx conf.py and specify at https://www.sphinx-doc.org/en/master/usage/configuration.html

sphinx_main([argv])

Classes

DisplayablePath(path, parent_path, is_last)

Path(*args, **kwargs)

PurePath subclass that can make system calls.