Merge pull request #3065 from jessica-mitchell/add-check-docext

Modify doc extensions to check for correct files

doc/htmldoc/_ext/add_button_notebook.py

@@ -96,17 +96,22 @@ def add_button_to_examples(app, env, docnames):
 
             lines = f.readlines()
 
-        # find the first heading of the file.
-        for i, item in enumerate(lines):
-            if item.startswith("-----"):
-                break
-
-        # insert prolog into rst file after heading
-        lines.insert(i + 1, prolog + "\n")
-
-        with open(file, "w") as f:
-            lines = "".join(lines)
-            f.write(lines)
+        # make sure rst file is auto generated Python file
+        check_line = lines[1]
+        if check_line.startswith(".."):
+            # find the first heading of the file.
+            for i, item in enumerate(lines):
+                if item.startswith("-----"):
+                    break
+
+            # insert prolog into rst file after heading
+            lines.insert(i + 1, prolog + "\n")
+
+            with open(file, "w") as f:
+                lines = "".join(lines)
+                f.write(lines)
+        else:
+            continue
 
 
 def setup(app):

doc/htmldoc/_ext/list_examples.py

@@ -103,10 +103,12 @@ def ModelMatchExamples():
             continue
         with open(filename, "r", errors="ignore") as file:
             content = file.read()
-            for model_file in model_files:
-                if model_file in content:
-                    matches.setdefault(model_file, []).append(filename)
-
+            if "AUTOMATICALLY GENERATED" in content:
+                for model_file in model_files:
+                    if model_file in content:
+                        matches.setdefault(model_file, []).append(filename)
+            else:
+                continue
     return matches