Fix filesystem case sensitivity issue with IQP docs

Eric-Arellano · Nov 8, 2024 · 92af9d0 · 92af9d0
1 parent e631685
commit 92af9d0
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -121,6 +121,14 @@
 napoleon_numpy_docstring = False
 
 
+# Autosummary generates stub filenames based on the import name.
+# Sometimes, two distinct interfaces only differ in capitalization; this
+# creates a problem on case-insensitive OS/filesystems like macOS. So,
+# we manually avoid the clash by renaming one of the files.
+autosummary_filename_map = {
+    "qiskit.circuit.library.iqp": "qiskit.circuit.library.iqp_function",
+}
+
 # ----------------------------------------------------------------------------------
 # Doctest
 # ----------------------------------------------------------------------------------