LCORE-581: refactored gendoc script

Author: tisnik

scripts/gen_doc.py

@@ -8,34 +8,51 @@
 from pathlib import Path
 
 
-for path in Path("src").rglob("*"):
-    if path.is_dir():
-        directory = path
-        cwd = os.getcwd()
-        os.chdir(directory)
-        print(directory)
-
-        try:
-            with open("README.md", "w", encoding="utf-8", newline="\n") as indexfile:
-                print(
-                    f"# List of source files stored in `{directory}` directory",
-                    file=indexfile,
-                )
-                print("", file=indexfile)
-                files = sorted(os.listdir())
-
-                for file in files:
-                    if file.endswith(".py"):
-                        print(f"## [{file}]({file})", file=indexfile)
-                        with open(file, "r", encoding="utf-8") as fin:
-                            source = fin.read()
-                        try:
-                            mod = ast.parse(source)
-                            doc = ast.get_docstring(mod)
-                        except SyntaxError:
-                            doc = None
-                        if doc:
-                            print(doc.splitlines()[0], file=indexfile)
-                        print(file=indexfile)
-        finally:
-            os.chdir(cwd)
+def generate_docfile(directory):
+    """Generate README.md in the CWD."""
+    with open("README.md", "w", encoding="utf-8", newline="\n") as indexfile:
+        print(
+            f"# List of source files stored in `{directory}` directory",
+            file=indexfile,
+        )
+        print("", file=indexfile)
+        files = sorted(os.listdir())
+
+        for file in files:
+            if file.endswith(".py"):
+                print(f"## [{file}]({file})", file=indexfile)
+                with open(file, "r", encoding="utf-8") as fin:
+                    source = fin.read()
+                try:
+                    mod = ast.parse(source)
+                    doc = ast.get_docstring(mod)
+                except SyntaxError:
+                    doc = None
+                if doc:
+                    print(doc.splitlines()[0], file=indexfile)
+                print(file=indexfile)
+
+
+def generate_documentation_on_path(path):
+    """Generate documentation for all the sources found in path."""
+    directory = path
+    cwd = os.getcwd()
+    os.chdir(directory)
+    print(directory)
+
+    try:
+        generate_docfile(directory)
+    finally:
+        os.chdir(cwd)
+
+
+def main():
+    """Entry point to this script, regenerates documentation in all directories."""
+    generate_documentation_on_path("src/")
+    for path in Path("src").rglob("*"):
+        if path.is_dir():
+            generate_documentation_on_path(path)
+
+
+if __name__ == "__main__":
+    main()