Fix docs build with Pygments 2.15 (#9948) (#9952)

The problem was because the latest version of Pygments included a docstring in `Lexer.__init__` that includes a crossreference to an object that Qiskit naturally doesn't have. We don't need to inherit the `__init__` docstring for this object; we're only interested in documenting the existence of object itself. (cherry picked from commit e598593) Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
Qiskit · Apr 11, 2023 · 32281ad · 32281ad
1 parent 595a68a
commit 32281ad
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/qiskit/qasm/__init__.py b/qiskit/qasm/__init__.py
@@ -30,13 +30,14 @@
 Pygments
 ========
 
-.. autosummary::
-   :toctree: ../stubs/
+.. autoclass:: OpenQASMLexer
+    :class-doc-from: class
 
-   OpenQASMLexer
-   QasmHTMLStyle
-   QasmTerminalStyle
+.. autoclass:: QasmHTMLStyle
+    :class-doc-from: class
 
+.. autoclass:: QasmTerminalStyle
+    :class-doc-from: class
 """
 
 from numpy import pi

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -20,7 +20,7 @@ Sphinx>=3.0.0
 qiskit-sphinx-theme>=1.6
 sphinx-autodoc-typehints==1.21.1  # revert to >=1.18 once the incompatibilities are fixed
 sphinx-design>=0.2.0
-pygments>=2.4,<2.15
+pygments>=2.4
 scikit-learn>=0.20.0
 scikit-quant<=0.7;platform_system != 'Windows'
 jax;platform_system != 'Windows'