File tree 3 files changed +13
-5
lines changed
ansibleplaybookgrapher/renderer
3 files changed +13
-5
lines changed Original file line number Diff line number Diff line change @@ -70,7 +70,7 @@ def render(
70
70
:param hide_empty_plays: Whether to hide empty plays or not when rendering the graph
71
71
:param hide_plays_without_roles: Whether to hide plays without any roles or not
72
72
:param kwargs:
73
- :return: The filename of the rendered file
73
+ :return: The path of the rendered file
74
74
"""
75
75
pass
76
76
Original file line number Diff line number Diff line change @@ -58,8 +58,13 @@ def render(
58
58
** kwargs ,
59
59
) -> str :
60
60
"""
61
- :param hide_plays_without_roles:
62
- :return: The filename where the playbooks where rendered
61
+ :param open_protocol_handler: The protocol handler name to use
62
+ :param open_protocol_custom_formats: The custom formats to use when the protocol handler is set to custom
63
+ :param output_filename: The output filename without any extension
64
+ :param view: Whether to open the rendered file in the default viewer
65
+ :param hide_empty_plays: Whether to hide empty plays or not when rendering the graph
66
+ :param hide_plays_without_roles: Whether to hide plays without any roles or not
67
+ :return: The path of the rendered file
63
68
"""
64
69
save_dot_file = kwargs .get ("save_dot_file" , False )
65
70
Original file line number Diff line number Diff line change @@ -57,12 +57,14 @@ def render(
57
57
) -> str :
58
58
"""
59
59
60
- :param hide_plays_without_roles:
61
60
:param open_protocol_handler: Not supported for the moment
62
61
:param open_protocol_custom_formats: Not supported for the moment
63
62
:param output_filename: The output filename without any extension
64
63
:param view: Not supported for the moment
65
64
:param hide_empty_plays: Whether to hide empty plays or not when rendering the graph
65
+ :param hide_plays_without_roles: Whether to hide plays without any roles or not
66
+ :param directive: Mermaid directive
67
+ :param orientation: Mermaid graph orientation
66
68
:param kwargs:
67
69
:return:
68
70
"""
@@ -95,7 +97,8 @@ def render(
95
97
)
96
98
97
99
mermaid_code += playbook_builder .build_playbook (
98
- hide_empty_plays = hide_empty_plays
100
+ hide_empty_plays = hide_empty_plays ,
101
+ hide_plays_without_roles = hide_plays_without_roles
99
102
)
100
103
link_order = playbook_builder .link_order
101
104
roles_built .update (playbook_builder .roles_built )
You can’t perform that action at this time.
0 commit comments