tools_doc_sphinx.tree_view_source_code¶

Summary¶

Script for extracting the tree view of source code, it automatically handles the gitignore file at the root directory

Functions¶

`tools_doc_sphinx.tree_view_source_code.get_ignored_items`(…)	Gets list of items to ignore in the tree view
`tools_doc_sphinx.tree_view_source_code.write_tree_view_recursive`(…)	Recursive function for writing tree view in a TXT file

API¶

Functions¶

tools_doc_sphinx.tree_view_source_code.get_ignored_items(dir_root, ignore_list)[source]¶

Gets list of items to ignore in the tree view

Parameters

dir_root (str) – root directory for the tree view
ignore_list (list) – patterns/items to look for

Returns

list of items to ignore in the tree view

Return type

list

tools_doc_sphinx.tree_view_source_code.write_tree_view_recursive(dir_root_path, output_path, dir_root_name=None, ignored_item_list=[], level=0)[source]¶

Recursive function for writing tree view in a TXT file

Parameters

dir_root_path (str) – path to the root directory for the tree view
output_path (str) – path to output file where to write the tree view
dir_root_name (str) – name to use as root directory inside the tree view, by default it is the basename of dir_root_path
ignored_item_list (list) – items to ignore in the tree view
level (int) – nesting level inside the package structure