Add alt text to images (#13555)

* Add alt text to images * Update operation.py * Update parameter.py * Update quantumcircuit.py * try breaking line * Update __init__.py * Update fourier_checking.py * Update graph_state.py * Update grover_operator.py * add more alt text and some missing directives * add nofigs for missing figures * Add more alt text * next set * need different text when there's no code * fix text when no code * more alt text * remove brackets * More alt text and some fixes * Adding more text * more alt text * missing file name * missing blank line * extra blank line * update allowlist * fix spacing * add more alt text * Apply suggestions from code review Co-authored-by: Eric Arellano <[email protected]> * Apply suggestions from code review Co-authored-by: Elena Peña Tapia <[email protected]> --------- Co-authored-by: Eric Arellano <[email protected]> Co-authored-by: Elena Peña Tapia <[email protected]>
Qiskit · Jan 9, 2025 · b872e88 · b872e88
1 parent 408741c
commit b872e88
Show file tree

Hide file tree

Showing 57 changed files with 172 additions and 71 deletions.
diff --git a/qiskit/circuit/__init__.py b/qiskit/circuit/__init__.py
@@ -64,6 +64,7 @@
 
 
 .. plot::
+   :alt: Circuit diagram output by the previous code.
    :include-source:
 
    from qiskit import QuantumCircuit
@@ -1144,6 +1145,7 @@ def __array__(self, dtype=None, copy=None):
 drawing:
 
 .. plot::
+    :alt: Circuit diagram output by the previous code.
     :include-source:
     :context:
     :show-source-link: False

diff --git a/qiskit/circuit/controlledgate.py b/qiskit/circuit/controlledgate.py
@@ -70,6 +70,7 @@ def __init__(
         Create a controlled standard gate and apply it to a circuit.
 
         .. plot::
+           :alt: Circuit diagram output by the previous code.
            :include-source:
 
            from qiskit import QuantumCircuit, QuantumRegister
@@ -84,6 +85,7 @@ def __init__(
         Create a controlled custom gate and apply it to a circuit.
 
         .. plot::
+           :alt: Circuit diagram output by the previous code.
            :include-source:
 
            from qiskit import QuantumCircuit, QuantumRegister

diff --git a/qiskit/circuit/library/__init__.py b/qiskit/circuit/library/__init__.py
@@ -26,6 +26,7 @@
 For example, to append a multi-controlled CNOT:
 
 .. plot::
+   :alt: Circuit diagram output by the previous code.
    :include-source:
 
    from qiskit.circuit.library import MCXGate

diff --git a/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py b/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py
@@ -37,6 +37,7 @@ class PiecewiseChebyshev(BlueprintCircuit):
     Examples:
 
         .. plot::
+           :alt: Circuit diagram output by the previous code.
            :include-source:
 
             import numpy as np

diff --git a/qiskit/circuit/library/basis_change/qft.py b/qiskit/circuit/library/basis_change/qft.py
@@ -38,6 +38,7 @@ class QFT(BlueprintCircuit):
     For 4 qubits, the circuit that implements this transformation is:
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit.library import QFT
        from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -48,6 +49,7 @@ class QFT(BlueprintCircuit):
     The respective circuit diagram is:
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit.library import QFT
        from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -64,6 +66,7 @@ class QFT(BlueprintCircuit):
     on 5 qubits with approximation degree 2 yields (the barriers are dropped in this example):
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit.library import QFT
        from qiskit.visualization.library import _generate_circuit_library_visualization

diff --git a/qiskit/circuit/library/boolean_logic/inner_product.py b/qiskit/circuit/library/boolean_logic/inner_product.py
@@ -55,6 +55,7 @@ class InnerProduct(QuantumCircuit):
 
     Reference Circuit:
         .. plot::
+           :alt: Diagram illustrating the previously described circuit.
 
            from qiskit.circuit.library import InnerProduct
            from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -121,6 +122,7 @@ class InnerProductGate(Gate):
 
     Reference Circuit:
         .. plot::
+           :alt: Diagram illustrating the previously described circuit.
 
            from qiskit.circuit import QuantumCircuit
            from qiskit.circuit.library import InnerProductGate

diff --git a/qiskit/circuit/library/boolean_logic/quantum_and.py b/qiskit/circuit/library/boolean_logic/quantum_and.py
@@ -32,6 +32,7 @@ class AND(QuantumCircuit):
     The AND gate without special flags equals the multi-controlled-X gate:
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit.library import AND
        from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -43,6 +44,7 @@ class AND(QuantumCircuit):
     ``[-1, 0, 0, 1, 1]``.
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit.library import AND
        from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -116,6 +118,7 @@ class AndGate(Gate):
     The AndGate gate without special flags equals the multi-controlled-X gate:
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit import QuantumCircuit
        from qiskit.circuit.library import AndGate
@@ -129,6 +132,7 @@ class AndGate(Gate):
     ``[-1, 0, 0, 1, 1]``.
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit import QuantumCircuit
        from qiskit.circuit.library import AndGate

diff --git a/qiskit/circuit/library/boolean_logic/quantum_or.py b/qiskit/circuit/library/boolean_logic/quantum_or.py
@@ -33,6 +33,7 @@ class OR(QuantumCircuit):
     The OR gate without special flags:
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit.library import OR
        from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -44,6 +45,7 @@ class OR(QuantumCircuit):
     flags ``[-1, 0, 0, 1, 1]``.
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit.library import OR
        from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -117,6 +119,7 @@ class OrGate(Gate):
     The OrGate gate without special flags:
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit import QuantumCircuit
        from qiskit.circuit.library import OrGate
@@ -130,6 +133,7 @@ class OrGate(Gate):
     flags ``[-1, 0, 0, 1, 1]``.
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit import QuantumCircuit
        from qiskit.circuit.library import OrGate

diff --git a/qiskit/circuit/library/boolean_logic/quantum_xor.py b/qiskit/circuit/library/boolean_logic/quantum_xor.py
@@ -53,6 +53,7 @@ def __init__(
 
         Reference Circuit:
             .. plot::
+               :alt: Diagram illustrating the previously described circuit.
 
                from qiskit.circuit.library import XOR
                from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -88,6 +89,7 @@ class BitwiseXorGate(Gate):
     Reference Circuit:
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit import QuantumCircuit
        from qiskit.circuit.library import BitwiseXorGate

diff --git a/qiskit/circuit/library/fourier_checking.py b/qiskit/circuit/library/fourier_checking.py
@@ -70,6 +70,7 @@ def __init__(self, f: Sequence[int], g: Sequence[int]) -> None:
 
         Reference Circuit:
             .. plot::
+               :alt: Diagram illustrating the previously described circuit.
 
                from qiskit.circuit.library import FourierChecking
                from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -124,6 +125,7 @@ def fourier_checking(f: Sequence[int], g: Sequence[int]) -> QuantumCircuit:
     **Reference Circuit:**
 
     .. plot::
+       :alt: Circuit diagram output by the previous code.
        :include-source:
 
        from qiskit.circuit.library import fourier_checking

diff --git a/qiskit/circuit/library/generalized_gates/gms.py b/qiskit/circuit/library/generalized_gates/gms.py
@@ -45,6 +45,7 @@ class GMS(QuantumCircuit):
     **Expanded Circuit:**
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit.library import GMS
        from qiskit.visualization.library import _generate_circuit_library_visualization

diff --git a/qiskit/circuit/library/generalized_gates/gr.py b/qiskit/circuit/library/generalized_gates/gr.py
@@ -45,6 +45,7 @@ class GR(QuantumCircuit):
     **Expanded Circuit:**
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit.library import GR
        from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -99,6 +100,7 @@ class GRX(GR):
     **Expanded Circuit:**
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
         from qiskit.circuit.library import GRX
         from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -147,6 +149,7 @@ class GRY(GR):
     **Expanded Circuit:**
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit.library import GRY
        from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -195,6 +198,7 @@ class GRZ(QuantumCircuit):
     **Expanded Circuit:**
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit.library import GRZ
        from qiskit.visualization.library import _generate_circuit_library_visualization

diff --git a/qiskit/circuit/library/generalized_gates/mcmt.py b/qiskit/circuit/library/generalized_gates/mcmt.py
@@ -129,6 +129,7 @@ class MCMTVChain(MCMT):
     **Expanded Circuit:**
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit.library import MCMTVChain, ZGate
        from qiskit.visualization.library import _generate_circuit_library_visualization

diff --git a/qiskit/circuit/library/generalized_gates/permutation.py b/qiskit/circuit/library/generalized_gates/permutation.py
@@ -54,6 +54,7 @@ def __init__(
 
         Reference Circuit:
             .. plot::
+               :alt: Diagram illustrating the previously described circuit.
 
                from qiskit.circuit.library import Permutation
                A = [2,4,3,0,1]
@@ -62,6 +63,7 @@ def __init__(
 
         Expanded Circuit:
             .. plot::
+               :alt: Diagram illustrating the previously described circuit.
 
                from qiskit.circuit.library import Permutation
                from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -116,6 +118,7 @@ def __init__(
 
         Reference Circuit:
             .. plot::
+               :alt: Diagram illustrating the previously described circuit.
 
                 from qiskit.circuit.quantumcircuit import QuantumCircuit
                 from qiskit.circuit.library import PermutationGate
@@ -127,6 +130,7 @@ def __init__(
 
         Expanded Circuit:
             .. plot::
+               :alt: Diagram illustrating the previously described circuit.
 
                 from qiskit.circuit.quantumcircuit import QuantumCircuit
                 from qiskit.circuit.library import PermutationGate

diff --git a/qiskit/circuit/library/graph_state.py b/qiskit/circuit/library/graph_state.py
@@ -41,6 +41,7 @@ class GraphState(QuantumCircuit):
     **Reference Circuit:**
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit.library import GraphState
        from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -105,6 +106,7 @@ class GraphStateGate(Gate):
     **Reference Circuit:**
 
     .. plot::
+        :alt: Circuit diagram output by the previous code.
         :include-source:
 
         from qiskit.circuit import QuantumCircuit

diff --git a/qiskit/circuit/library/grover_operator.py b/qiskit/circuit/library/grover_operator.py
@@ -103,6 +103,7 @@ def grover_operator(
         We can construct a Grover operator just from the phase oracle:
 
         .. plot::
+            :alt: Circuit diagram output by the previous code.
             :include-source:
             :context:
 
@@ -117,6 +118,7 @@ def grover_operator(
         We can also modify the state preparation:
 
         .. plot::
+            :alt: Circuit diagram output by the previous code.
             :include-source:
             :context: close-figs
 
@@ -132,6 +134,7 @@ def grover_operator(
         the oracle:
 
         .. plot::
+            :alt: Circuit diagram output by the previous code.
             :include-source:
             :context: close-figs
 
@@ -149,6 +152,7 @@ def grover_operator(
         objects:
 
         .. plot::
+            :alt: Circuit diagram output by the previous code.
             :include-source:
             :context: close-figs
 

diff --git a/qiskit/circuit/library/hidden_linear_function.py b/qiskit/circuit/library/hidden_linear_function.py
@@ -55,6 +55,7 @@ class HiddenLinearFunction(QuantumCircuit):
     **Reference Circuit:**
 
         .. plot::
+           :alt: Diagram illustrating the previously described circuit.
 
            from qiskit.circuit.library import HiddenLinearFunction
            from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -123,6 +124,7 @@ def hidden_linear_function(adjacency_matrix: list | np.ndarray) -> QuantumCircui
     **Reference Circuit:**
 
     .. plot::
+       :alt: Circuit diagram output by the previous code.
        :include-source:
 
        from qiskit.circuit.library import hidden_linear_function

diff --git a/qiskit/circuit/library/iqp.py b/qiskit/circuit/library/iqp.py
@@ -38,6 +38,7 @@ class IQP(QuantumCircuit):
     **Reference Circuit:**
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit.library import IQP
        A = [[6, 5, 3], [5, 4, 5], [3, 5, 1]]
@@ -47,6 +48,7 @@ class IQP(QuantumCircuit):
     **Expanded Circuit:**
 
         .. plot::
+           :alt: Diagram illustrating the previously described circuit.
 
            from qiskit.circuit.library import IQP
            from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -97,6 +99,7 @@ def iqp(
     **Reference Circuit:**
 
     .. plot::
+       :alt: Diagram illustrating the previously described circuit.
 
        from qiskit.circuit.library import iqp
        A = [[6, 5, 3], [5, 4, 5], [3, 5, 1]]
@@ -106,6 +109,7 @@ def iqp(
     **Expanded Circuit:**
 
         .. plot::
+           :alt: Diagram illustrating the previously described circuit.
 
            from qiskit.circuit.library import iqp
            from qiskit.visualization.library import _generate_circuit_library_visualization
@@ -154,6 +158,7 @@ def random_iqp(
     Example:
 
     .. plot::
+       :alt: Circuit diagram output by the previous code.
        :include-source:
 
        from qiskit.circuit.library import random_iqp

diff --git a/qiskit/circuit/library/n_local/efficient_su2.py b/qiskit/circuit/library/n_local/efficient_su2.py
@@ -71,6 +71,7 @@ def efficient_su2(
         CX gates, is equivalent to an all-to-all entanglement:
 
         .. plot::
+            :alt: Circuit diagram output by the previous code.
             :include-source:
             :context:
 
@@ -84,6 +85,7 @@ def efficient_su2(
         For example:
 
         .. plot::
+            :alt: Circuit diagram output by the previous code.
             :include-source:
             :context: close-figs