add check for missing or unneeded accelerated style include

doc/utils/check-styles.py

@@ -61,16 +61,50 @@ region = {}
 total = 0
 
 index_pattern = re.compile(r"^.. index:: (compute|fix|pair_style|angle_style|bond_style|dihedral_style|improper_style|kspace_style|dump)\s+([a-zA-Z0-9/_]+)$")
+accel_pattern = re.compile(r"^.. include::\s+accel_styles.rst$")
 style_pattern = re.compile(r"(.+)Style\((.+),(.+)\)")
+cmd_pattern = re.compile(r"^.. index:: ([a-zA-Z0-9/_]+)$")
 upper = re.compile("[A-Z]+")
-gpu = re.compile("(.+)/gpu$")
-intel = re.compile("(.+)/intel$")
-kokkos = re.compile("(.+)/kk$")
-kokkos_skip = re.compile("(.+)/kk/(host|device)$")
-omp = re.compile("(.+)/omp$")
-opt = re.compile("(.+)/opt$")
+gpu = re.compile("(.+)/gpu\\s*$")
+intel = re.compile("(.+)/intel\\s*$")
+kokkos = re.compile("(.+)/kk$\\s*")
+kokkos_skip = re.compile("(.+)/kk/(host|device)\\s*$")
+omp = re.compile("(.+)/omp\\s*$")
+opt = re.compile("(.+)/opt\\s*$")
 removed = re.compile("(.*)Deprecated$")
 
+accel_pattern = re.compile(r"^.. include::\s+accel_styles.rst$")
+
+def require_accel_include(path):
+    found = False
+    needs = False
+    # handle exceptions
+    if path == "src/min_style.rst" : needs = True
+    if path == "src/atom_style.rst" : needs = True
+    # check file
+    with open(path, 'r') as reader:
+        for line in reader:
+            m = accel_pattern.match(line)
+            if m: found = True
+            m = index_pattern.match(line)
+            if m:
+                if gpu.match(line): needs = True
+                if omp.match(line): needs = True
+                if kokkos.match(line): needs = True
+                if intel.match(line): needs = True
+                if opt.match(line): needs = True
+            m = cmd_pattern.match(line)
+            if m:
+                if gpu.match(line): needs = True
+                if omp.match(line): needs = True
+                if kokkos.match(line): needs = True
+                if intel.match(line): needs = True
+                if opt.match(line): needs = True
+    if needs and not found:
+        print("Missing '.. include:: accel_style.rst' in file ", path)
+    if not needs and found:
+        print("Have '.. include:: accel_style.rst' without accelerated styles in file ", path)
+
 def load_index_entries_in_file(path):
     entries = []
     with open(path, 'r') as reader:
@@ -82,6 +116,11 @@ def load_index_entries_in_file(path):
                 entries.append((command_type, style))
     return entries
 
+def check_accel_includes():
+    rst_files = glob(os.path.join(doc_dir, '*.rst'))
+    for f in rst_files:
+        require_accel_include(f)
+
 def load_index_entries():
     index = {'compute': set(), 'fix': set(), 'pair_style': set(), 'angle_style': set(),
              'bond_style': set(), 'dihedral_style': set(), 'improper_style': set(),
@@ -249,6 +288,8 @@ Total number of styles (including suffixes): %d""" \
        len(fix), len(improper), len(integrate), len(kspace), \
        len(minimize), len(pair), len(reader), len(region), total))
 
+check_accel_includes()
+
 index = load_index_entries()
 
 total_index = 0