Merge pull request #79 from ontime-re/76-update-documentation-notebooks

76 update documentation notebooks
ontime-re · Jan 8, 2025 · c868b0d · c868b0d
2 parents 8748f30 + f69a63a
commit c868b0d
Show file tree

Hide file tree

Showing 25 changed files with 4,302 additions and 2,933 deletions.
diff --git a/Makefile b/Makefile
@@ -50,7 +50,7 @@ jupyter:
 
 run-notebooks:
 	@echo "Running notebooks"
-	@cd docs && poetry run python run_notebooks.py
+	poetry run python docs/run_notebooks.py
 
 test:
 	@echo "Running tests"

diff --git a/docs/getting_started.ipynb b/docs/getting_started.ipynb
diff --git a/docs/run_notebooks.py b/docs/run_notebooks.py
@@ -1,5 +1,14 @@
 import papermill as pm
 from pathlib import Path
+import subprocess
+
+def is_git_ignored(file_path):
+    result = subprocess.run(
+        ["git", "check-ignore", "-q", str(file_path)],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+    )
+    return result.returncode == 0
 
 print("########################################")
 print("#          Notebook Executor           #")
@@ -8,11 +17,14 @@
 current_directory = Path(".")
 files = [file for file in current_directory.rglob("*.ipynb")]
 
+# filter out git-ignored files
+filtered_files = [file for file in files if not is_git_ignored(file)]
+
 print("\n")
 print("Files to execute:\n")
-print(files)
+print(filtered_files)
 
-for file in files:
+for file in filtered_files:
     # print("\n")
     print(f"Executing: {file}")
     pm.execute_notebook(input_path=file, output_path=file, progress_bar=False)

diff --git a/docs/tutorials/0_create-an-anomaly-detection-workflow.ipynb b/docs/tutorials/0_create-an-anomaly-detection-workflow.ipynb
diff --git a/docs/user_guide/0_core/0.1.1_time-series_data-loading.ipynb b/docs/user_guide/0_core/0.1.1_time-series_data-loading.ipynb
diff --git a/docs/user_guide/0_core/0.1_time-series.ipynb b/docs/user_guide/0_core/0.1_time-series.ipynb
diff --git a/docs/user_guide/0_core/0.2_detectors.ipynb b/docs/user_guide/0_core/0.2_detectors.ipynb
diff --git a/docs/user_guide/0_core/0.3_generators.ipynb b/docs/user_guide/0_core/0.3_generators.ipynb