Generate API documentation 39cd8a8

C2QA · Apr 11, 2024 · b476aaf · b476aaf
1 parent dd12864
commit b476aaf
Show file tree

Hide file tree

Showing 25 changed files with 244 additions and 306 deletions.
diff --git a/all-documents.html b/all-documents.html
@@ -211,7 +211,7 @@ <h1>All Documents</h1>
             <div class="type">Module</div>
             <div class="kind">Module</div>
             <div class="privacy">PUBLIC</div>
-            <div class="summary"><span class="undocumented">No module docstring; 9/11 functions documented</span></div>
+            <div class="summary"><span class="undocumented">No module docstring; 8/10 functions documented</span></div>
           </li><li id="c2qa.operators.xQB">
 
             <div class="fullName">c2qa<wbr></wbr>.operators<wbr></wbr>.x<wbr></wbr>QB</div>
@@ -1644,14 +1644,6 @@ <h1>All Documents</h1>
             <div class="kind">Function</div>
             <div class="privacy">PRIVATE</div>
             <div class="summary"><span class="undocumented">Undocumented</span></div>
-          </li><li id="c2qa.wigner._wigner_iterative">
-
-            <div class="fullName">c2qa<wbr></wbr>.wigner<wbr></wbr>._wigner<wbr></wbr>_iterative</div>
-            <div class="url">c2qa.wigner.html#_wigner_iterative</div>
-            <div class="type">Function</div>
-            <div class="kind">Function</div>
-            <div class="privacy">PRIVATE</div>
-            <div class="summary">Wigner function as implemented in QuTiP (i.e., copy/paste). QuTiP is released under the BSD 3-clause license: <a class="rst-reference external" href="https://github.com/qutip/qutip/blob/master/LICENSE.txt" target="_top">https://github.com/qutip/qutip/blob/master/LICENSE.txt</a></div>
           </li><li id="c2qa.wigner.plot_wigner">
 
             <div class="fullName">c2qa<wbr></wbr>.wigner<wbr></wbr>.plot<wbr></wbr>_wigner</div>

diff --git a/c2qa.animate.html b/c2qa.animate.html
diff --git a/c2qa.circuit.CVCircuit.html b/c2qa.circuit.CVCircuit.html
diff --git a/c2qa.circuit.html b/c2qa.circuit.html
@@ -331,7 +331,7 @@ <h1 class="module"><code><code><a href="index.html" class="internal-link">c2qa</
         </div>
 
         <div class="extrasDocstring">
-          <a href="https://github.com/C2QA/bosonic-qiskit/tree/02f588905a04fb8a21b928cc5f409bfbc76dd7d2/c2qa/circuit.py" class="sourceLink">(source)</a>
+          <a href="https://github.com/C2QA/bosonic-qiskit/tree/39cd8a874a3ebb6e7b7ec5fedab1bcbba0c66057/c2qa/circuit.py" class="sourceLink">(source)</a>
           <p></p>
         </div>
 
@@ -368,7 +368,7 @@ <h1 class="module"><code><code><a href="index.html" class="internal-link">c2qa</
   <div class="container">
     <a href="index.html">API Documentation</a> for <a href="https://github.com/C2QA/bosonic-qiskit" class="projecthome">bosonic-qiskit</a>,
   generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-    23.9.1 at 2024-03-04 18:46:56.
+    23.9.1 at 2024-04-11 13:27:50.
   </div>
 
   <!-- Search related scripts needs to be loaded at the end of HTML 

diff --git a/c2qa.discretize.html b/c2qa.discretize.html
@@ -381,7 +381,7 @@ <h1 class="module"><code><code><a href="index.html" class="internal-link">c2qa</
         </div>
 
         <div class="extrasDocstring">
-          <a href="https://github.com/C2QA/bosonic-qiskit/tree/02f588905a04fb8a21b928cc5f409bfbc76dd7d2/c2qa/discretize.py" class="sourceLink">(source)</a>
+          <a href="https://github.com/C2QA/bosonic-qiskit/tree/39cd8a874a3ebb6e7b7ec5fedab1bcbba0c66057/c2qa/discretize.py" class="sourceLink">(source)</a>
           <p></p>
         </div>
 
@@ -444,7 +444,7 @@ <h1 class="module"><code><code><a href="index.html" class="internal-link">c2qa</
 
 
     <span class="py-keyword">def</span> <span class="py-defname">discretize_circuits</span><span class="function-signature">(circuit: <code><a href="c2qa.circuit.CVCircuit.html" class="internal-link" title="c2qa.circuit.CVCircuit">CVCircuit</a></code>, segments_per_gate: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code> = 10, keep_state: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code> = <a href="https://docs.python.org/3/library/constants.html#True" class="intersphinx-link">True</a>, qubit: <code>qiskit.circuit.quantumcircuit.QubitSpecifier</code> = <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a>, cbit: <code>qiskit.circuit.quantumcircuit.QubitSpecifier</code> = <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a>, sequential_subcircuit: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code> = <a href="https://docs.python.org/3/library/constants.html#False" class="intersphinx-link">False</a>)</span>:
-    <a class="sourceLink" href="https://github.com/C2QA/bosonic-qiskit/tree/02f588905a04fb8a21b928cc5f409bfbc76dd7d2/c2qa/discretize.py#L9">
+    <a class="sourceLink" href="https://github.com/C2QA/bosonic-qiskit/tree/39cd8a874a3ebb6e7b7ec5fedab1bcbba0c66057/c2qa/discretize.py#L9">
 
       (source)
     </a>
@@ -474,7 +474,7 @@ <h1 class="module"><code><code><a href="index.html" class="internal-link">c2qa</
 
 
     <span class="py-keyword">def</span> <span class="py-defname">discretize_single_circuit</span><span class="function-signature">(circuit: <code><a href="c2qa.circuit.CVCircuit.html" class="internal-link" title="c2qa.circuit.CVCircuit">CVCircuit</a></code>, segments_per_gate: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code> = 10, epsilon: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a>, sequential_subcircuit: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code> = <a href="https://docs.python.org/3/library/constants.html#False" class="intersphinx-link">False</a>, statevector_per_segment: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code> = <a href="https://docs.python.org/3/library/constants.html#False" class="intersphinx-link">False</a>, statevector_label: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code> = <span class="rst-variable-quote">'</span><span class="rst-variable-string">segment_</span><span class="rst-variable-quote">'</span>, noise_passes=<a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a>)</span>:
-    <a class="sourceLink" href="https://github.com/C2QA/bosonic-qiskit/tree/02f588905a04fb8a21b928cc5f409bfbc76dd7d2/c2qa/discretize.py#L65">
+    <a class="sourceLink" href="https://github.com/C2QA/bosonic-qiskit/tree/39cd8a874a3ebb6e7b7ec5fedab1bcbba0c66057/c2qa/discretize.py#L65">
 
       (source)
     </a>
@@ -504,7 +504,7 @@ <h1 class="module"><code><code><a href="index.html" class="internal-link">c2qa</
 
 
     <span class="py-keyword">def</span> <span class="py-defname">__discretize_instruction</span><span class="function-signature">(inst: <code>qiskit.circuit.instruction.Instruction</code>, segments_per_gate: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code>, keep_state: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code>)</span>:
-    <a class="sourceLink" href="https://github.com/C2QA/bosonic-qiskit/tree/02f588905a04fb8a21b928cc5f409bfbc76dd7d2/c2qa/discretize.py#L221">
+    <a class="sourceLink" href="https://github.com/C2QA/bosonic-qiskit/tree/39cd8a874a3ebb6e7b7ec5fedab1bcbba0c66057/c2qa/discretize.py#L221">
 
       (source)
     </a>
@@ -531,7 +531,7 @@ <h1 class="module"><code><code><a href="index.html" class="internal-link">c2qa</
 
 
     <span class="py-keyword">def</span> <span class="py-defname">__discretize_parameterized</span><span class="function-signature">(inst: <code>qiskit.circuit.instruction.Instruction</code>, segments_per_gate: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code>, keep_state: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code>, discretized_param_indices: <code><a href="https://docs.python.org/3/library/stdtypes.html#list" class="intersphinx-link">list</a></code> = [])</span>:
-    <a class="sourceLink" href="https://github.com/C2QA/bosonic-qiskit/tree/02f588905a04fb8a21b928cc5f409bfbc76dd7d2/c2qa/discretize.py#L155">
+    <a class="sourceLink" href="https://github.com/C2QA/bosonic-qiskit/tree/39cd8a874a3ebb6e7b7ec5fedab1bcbba0c66057/c2qa/discretize.py#L155">
 
       (source)
     </a>
@@ -558,7 +558,7 @@ <h1 class="module"><code><code><a href="index.html" class="internal-link">c2qa</
 
 
     <span class="py-keyword">def</span> <span class="py-defname">__discretize_subcircuit</span><span class="function-signature">(subcircuit: <code>qiskit.QuantumCircuit</code>, segments_per_gate: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code>, keep_state: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code>, sequential_subcircuit: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code>)</span>:
-    <a class="sourceLink" href="https://github.com/C2QA/bosonic-qiskit/tree/02f588905a04fb8a21b928cc5f409bfbc76dd7d2/c2qa/discretize.py#L187">
+    <a class="sourceLink" href="https://github.com/C2QA/bosonic-qiskit/tree/39cd8a874a3ebb6e7b7ec5fedab1bcbba0c66057/c2qa/discretize.py#L187">
 
       (source)
     </a>
@@ -585,7 +585,7 @@ <h1 class="module"><code><code><a href="index.html" class="internal-link">c2qa</
 
 
     <span class="py-keyword">def</span> <span class="py-defname">__to_segments</span><span class="function-signature">(inst: <code>qiskit.circuit.instruction.Instruction</code>, segments_per_gate: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code>, keep_state: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code>, sequential_subcircuit: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code>)</span>:
-    <a class="sourceLink" href="https://github.com/C2QA/bosonic-qiskit/tree/02f588905a04fb8a21b928cc5f409bfbc76dd7d2/c2qa/discretize.py#L131">
+    <a class="sourceLink" href="https://github.com/C2QA/bosonic-qiskit/tree/39cd8a874a3ebb6e7b7ec5fedab1bcbba0c66057/c2qa/discretize.py#L131">
 
       (source)
     </a>
@@ -611,7 +611,7 @@ <h1 class="module"><code><code><a href="index.html" class="internal-link">c2qa</
   <div class="container">
     <a href="index.html">API Documentation</a> for <a href="https://github.com/C2QA/bosonic-qiskit" class="projecthome">bosonic-qiskit</a>,
   generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-    23.9.1 at 2024-03-04 18:46:56.
+    23.9.1 at 2024-04-11 13:27:50.
   </div>
 
   <!-- Search related scripts needs to be loaded at the end of HTML 

diff --git a/c2qa.html b/c2qa.html
@@ -289,7 +289,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">c2qa<
         </div>
 
         <div class="extrasDocstring">
-          <a href="https://github.com/C2QA/bosonic-qiskit/tree/02f588905a04fb8a21b928cc5f409bfbc76dd7d2/c2qa/__init__.py" class="sourceLink">(source)</a>
+          <a href="https://github.com/C2QA/bosonic-qiskit/tree/39cd8a874a3ebb6e7b7ec5fedab1bcbba0c66057/c2qa/__init__.py" class="sourceLink">(source)</a>
           <p></p>
         </div>
 
@@ -345,7 +345,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">c2qa<
 
     <td>Module</td>
     <td><code><a href="c2qa.wigner.html" class="internal-link" title="c2qa.wigner">wigner</a></code></td>
-    <td><span class="undocumented">No module docstring; 9/11 functions documented</span></td>
+    <td><span class="undocumented">No module docstring; 8/10 functions documented</span></td>
   </tr>
 </table>
 
@@ -366,7 +366,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">c2qa<
   <div class="container">
     <a href="index.html">API Documentation</a> for <a href="https://github.com/C2QA/bosonic-qiskit" class="projecthome">bosonic-qiskit</a>,
   generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-    23.9.1 at 2024-03-04 18:46:56.
+    23.9.1 at 2024-04-11 13:27:50.
   </div>
 
   <!-- Search related scripts needs to be loaded at the end of HTML