Merge pull request #2191 from tisnik/lcore-3141-ability-to-disable-some-directories

LCORE-3141: Ability to disable some directories

Author: tisnik

scripts/gen_doc.py

@@ -8,6 +8,20 @@
 
 DIRECTORIES = ["src", "tests/unit", "tests/integration", "tests/e2e"]
 
+# README.md files won't be generated in following directories
+DIRS_TO_SKIP = {
+    "tests/integration",
+    "tests/e2e",
+    "tests/e2e/configuration",
+    "tests/e2e/rag",
+    "tests/e2e/secrets",
+    "tests/e2e/skills",
+    "tests/e2e/skills/echo",
+    "tests/e2e/skills/echo/references",
+    "tests/e2e/skills/summarize",
+    "tests/e2e/skills/summarize/references",
+}
+
 
 def generate_docfile(directory: Path) -> None:
     """
@@ -47,17 +61,25 @@ def generate_documentation_on_path(path: Path) -> None:
 
     This function generate README.md for Python sources in the given directory.
 
+    Directory can be skipped if it's part of DIRS_TO_SKIP global list.
+
     Parameters:
     ----------
         path (str or os.PathLike): Directory in which to generate the README.md file.
     """
     directory = path
+
+    # directory can be skipped if it's part of DIRS_TO_SKIP global list.
+    if path.as_posix() in DIRS_TO_SKIP:
+        print(f"[gendoc] Skipping {path}")
+        return
+
     cwd = os.getcwd()
-    os.chdir(directory)
-    print(f"[gendoc] Generating README.md in: {directory}")
+    os.chdir(path)
 
     try:
-        generate_docfile(directory)
+        print(f"[gendoc] Generating README.md in: {path}")
+        generate_docfile(path)
     finally:
         os.chdir(cwd)