Fix autoapi detection of changed configuration

Author: PProfizi

doc/source/conf.py

@@ -1,6 +1,7 @@
 from datetime import datetime
 from glob import glob
 import os
+import sys
 from pathlib import Path
 import subprocess
 
@@ -16,6 +17,9 @@
 from ansys.dpf.core import __version__, server, server_factory
 from ansys.dpf.core.examples import get_example_required_minimum_dpf_version
 
+# Make sphinx_utilities modules importable
+sys.path.append(os.path.join(os.path.dirname(__file__), "../sphinx_utilities"))
+
 # Manage errors
 pyvista.set_error_output_file("errors.txt")
 # Ensure that offscreen rendering is used for docs generation
@@ -62,7 +66,7 @@
 ignored_pattern = r"(ignore"
 header_flag = "\"\"\""
 note_flag = r".. note::"
-for example in glob(r"../../examples/**/*.py"):
+for example in sorted(glob(r"../../examples/**/*.py")):
     minimum_version_str = get_example_required_minimum_dpf_version(example)
     if float(server_version) - float(minimum_version_str) < -0.05:
         example_name = example.split(os.path.sep)[-1]
@@ -164,32 +168,6 @@
 
 
 # -- Sphinx Gallery Options
-from sphinx_gallery.sorting import FileNameSortKey
-
-
-def reset_servers(gallery_conf, fname, when):
-    import gc
-
-    import psutil
-
-    from ansys.dpf.core import server
-
-    gc.collect()
-    server.shutdown_all_session_servers()
-
-    proc_name = "Ans.Dpf.Grpc"
-    nb_procs = 0
-    for proc in psutil.process_iter():
-        try:
-            # check whether the process name matches
-            if proc_name in proc.name():
-                proc.kill()
-                nb_procs += 1
-        except psutil.NoSuchProcess:
-            pass
-    print(f"Counted {nb_procs} {proc_name} processes {when} example {fname}.")
-
-
 sphinx_gallery_conf = {
     # convert rst to md for ipynb
     "pypandoc": True,
@@ -206,15 +184,15 @@ def reset_servers(gallery_conf, fname, when):
     # Remove the "Download all examples" button from the top level gallery
     "download_all_examples": False,
     # Sort gallery example by file name instead of number of lines (default)
-    "within_subsection_order": FileNameSortKey,
+    "within_subsection_order": "FileNameSortKey",
     # directory where function granular galleries are stored
     "backreferences_dir": None,
     "image_scrapers": ("pyvista", "matplotlib"),
     # 'first_notebook_cell': ("%matplotlib inline\n"
     #                         "from pyvista import set_plot_theme\n"
     #                         "set_plot_theme('document')"),
     "reset_modules_order": 'both',
-    "reset_modules": (reset_servers,),
+    "reset_modules": ("reset_servers.reset_servers",),
 }
 
 

doc/sphinx_utilities/reset_servers.py

@@ -0,0 +1,22 @@
+#
+def reset_servers(gallery_conf, fname, when):
+    import gc
+
+    import psutil
+
+    from ansys.dpf.core import server
+
+    gc.collect()
+    server.shutdown_all_session_servers()
+
+    proc_name = "Ans.Dpf.Grpc"
+    nb_procs = 0
+    for proc in psutil.process_iter():
+        try:
+            # check whether the process name matches
+            if proc_name in proc.name():
+                proc.kill()
+                nb_procs += 1
+        except psutil.NoSuchProcess:
+            pass
+    print(f"Counted {nb_procs} {proc_name} processes {when} example {fname}.")