Merge pull request #69 from ycexiao/rm-copied-notebook

docs: remove copied notebook files after building the documentation

Author: sbillinge

docs/source/conf.py

@@ -38,12 +38,26 @@
 # Include notebooks at build time.
 root_dir = Path(__file__).resolve().parents[1]
 external_nb_dir = root_dir / "examples"
+copied_files = []
 for f in external_nb_dir.glob("*.ipynb"):
     dest = Path(__file__).parent / "examples" / f.name
     if dest.exists():
         dest.unlink()
+    copied_files.append(dest)
     shutil.copy(f, dest)
 
+
+def post_build_hook(app, exception):
+    """Remove copied files after building documentation."""
+    for f in copied_files:
+        if f.exists():
+            f.unlink()
+
+
+def setup(app):
+    app.connect("build-finished", post_build_hook)
+
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.

news/rm-copied-notebook.rst

@@ -0,0 +1,23 @@
+**Added:**
+
+* No news added: Remove the copied notebooks after building the documentation.
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>