test autosummary additions

vprusso · Nov 10, 2023 · b2272c4 · b2272c4
1 parent 9272de3
commit b2272c4
Show file tree

Hide file tree

Showing 46 changed files with 268 additions and 27 deletions.
diff --git a/docs/_autosummary/toqito.channel_metrics.completely_bounded_spectral_norm.rst b/docs/_autosummary/toqito.channel_metrics.completely_bounded_spectral_norm.rst
@@ -0,0 +1,6 @@
+toqito.channel\_metrics.completely\_bounded\_spectral\_norm
+===========================================================
+
+.. currentmodule:: toqito.channel_metrics
+
+.. autofunction:: completely_bounded_spectral_norm
diff --git a/docs/_autosummary/toqito.channel_metrics.completely_bounded_trace_norm.rst b/docs/_autosummary/toqito.channel_metrics.completely_bounded_trace_norm.rst
@@ -0,0 +1,6 @@
+toqito.channel\_metrics.completely\_bounded\_trace\_norm
+========================================================
+
+.. currentmodule:: toqito.channel_metrics
+
+.. autofunction:: completely_bounded_trace_norm
diff --git a/docs/_autosummary/toqito.channel_metrics.fidelity_of_separability.rst b/docs/_autosummary/toqito.channel_metrics.fidelity_of_separability.rst
@@ -0,0 +1,6 @@
+toqito.channel\_metrics.fidelity\_of\_separability
+==================================================
+
+.. currentmodule:: toqito.channel_metrics
+
+.. autofunction:: fidelity_of_separability
diff --git a/docs/_autosummary/toqito.matrices.clock.rst b/docs/_autosummary/toqito.matrices.clock.rst
@@ -0,0 +1,6 @@
+toqito.matrices.clock
+=====================
+
+.. currentmodule:: toqito.matrices
+
+.. autofunction:: clock
diff --git a/docs/_autosummary/toqito.matrices.cnot.rst b/docs/_autosummary/toqito.matrices.cnot.rst
@@ -0,0 +1,6 @@
+toqito.matrices.cnot
+====================
+
+.. currentmodule:: toqito.matrices
+
+.. autofunction:: cnot
diff --git a/docs/_autosummary/toqito.matrices.fourier.rst b/docs/_autosummary/toqito.matrices.fourier.rst
@@ -0,0 +1,6 @@
+toqito.matrices.fourier
+=======================
+
+.. currentmodule:: toqito.matrices
+
+.. autofunction:: fourier
diff --git a/docs/_autosummary/toqito.matrices.gell_mann.rst b/docs/_autosummary/toqito.matrices.gell_mann.rst
@@ -0,0 +1,6 @@
+toqito.matrices.gell\_mann
+==========================
+
+.. currentmodule:: toqito.matrices
+
+.. autofunction:: gell_mann
diff --git a/docs/_autosummary/toqito.matrices.gen_gell_mann.rst b/docs/_autosummary/toqito.matrices.gen_gell_mann.rst
@@ -0,0 +1,6 @@
+toqito.matrices.gen\_gell\_mann
+===============================
+
+.. currentmodule:: toqito.matrices
+
+.. autofunction:: gen_gell_mann
diff --git a/docs/_autosummary/toqito.matrices.gen_pauli.rst b/docs/_autosummary/toqito.matrices.gen_pauli.rst
@@ -0,0 +1,6 @@
+toqito.matrices.gen\_pauli
+==========================
+
+.. currentmodule:: toqito.matrices
+
+.. autofunction:: gen_pauli
diff --git a/docs/_autosummary/toqito.matrices.hadamard.rst b/docs/_autosummary/toqito.matrices.hadamard.rst
@@ -0,0 +1,6 @@
+toqito.matrices.hadamard
+========================
+
+.. currentmodule:: toqito.matrices
+
+.. autofunction:: hadamard
diff --git a/docs/_autosummary/toqito.matrices.iden.rst b/docs/_autosummary/toqito.matrices.iden.rst
@@ -0,0 +1,6 @@
+toqito.matrices.iden
+====================
+
+.. currentmodule:: toqito.matrices
+
+.. autofunction:: iden
diff --git a/docs/_autosummary/toqito.matrices.pauli.rst b/docs/_autosummary/toqito.matrices.pauli.rst
@@ -0,0 +1,6 @@
+toqito.matrices.pauli
+=====================
+
+.. currentmodule:: toqito.matrices
+
+.. autofunction:: pauli
diff --git a/docs/_autosummary/toqito.matrices.shift.rst b/docs/_autosummary/toqito.matrices.shift.rst
@@ -0,0 +1,6 @@
+toqito.matrices.shift
+=====================
+
+.. currentmodule:: toqito.matrices
+
+.. autofunction:: shift
diff --git a/docs/_autosummary/toqito.matrices.standard_basis.rst b/docs/_autosummary/toqito.matrices.standard_basis.rst
@@ -0,0 +1,6 @@
+toqito.matrices.standard\_basis
+===============================
+
+.. currentmodule:: toqito.matrices
+
+.. autofunction:: standard_basis
diff --git a/docs/_autosummary/toqito.matrix_ops.inner_product.rst b/docs/_autosummary/toqito.matrix_ops.inner_product.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_ops.inner\_product
+=================================
+
+.. currentmodule:: toqito.matrix_ops
+
+.. autofunction:: inner_product
diff --git a/docs/_autosummary/toqito.matrix_ops.outer_product.rst b/docs/_autosummary/toqito.matrix_ops.outer_product.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_ops.outer\_product
+=================================
+
+.. currentmodule:: toqito.matrix_ops
+
+.. autofunction:: outer_product
diff --git a/docs/_autosummary/toqito.matrix_ops.tensor.rst b/docs/_autosummary/toqito.matrix_ops.tensor.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_ops.tensor
+=========================
+
+.. currentmodule:: toqito.matrix_ops
+
+.. autofunction:: tensor
diff --git a/docs/_autosummary/toqito.matrix_ops.unvec.rst b/docs/_autosummary/toqito.matrix_ops.unvec.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_ops.unvec
+========================
+
+.. currentmodule:: toqito.matrix_ops
+
+.. autofunction:: unvec
diff --git a/docs/_autosummary/toqito.matrix_ops.vec.rst b/docs/_autosummary/toqito.matrix_ops.vec.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_ops.vec
+======================
+
+.. currentmodule:: toqito.matrix_ops
+
+.. autofunction:: vec
diff --git a/docs/_autosummary/toqito.matrix_ops.vectors_from_gram_matrix.rst b/docs/_autosummary/toqito.matrix_ops.vectors_from_gram_matrix.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_ops.vectors\_from\_gram\_matrix
+==============================================
+
+.. currentmodule:: toqito.matrix_ops
+
+.. autofunction:: vectors_from_gram_matrix
diff --git a/docs/_autosummary/toqito.matrix_ops.vectors_to_gram_matrix.rst b/docs/_autosummary/toqito.matrix_ops.vectors_to_gram_matrix.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_ops.vectors\_to\_gram\_matrix
+============================================
+
+.. currentmodule:: toqito.matrix_ops
+
+.. autofunction:: vectors_to_gram_matrix
diff --git a/docs/_autosummary/toqito.matrix_props.is_block_positive.rst b/docs/_autosummary/toqito.matrix_props.is_block_positive.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_block\_positive
+========================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_block_positive
diff --git a/docs/_autosummary/toqito.matrix_props.is_circulant.rst b/docs/_autosummary/toqito.matrix_props.is_circulant.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_circulant
+==================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_circulant
diff --git a/docs/_autosummary/toqito.matrix_props.is_commuting.rst b/docs/_autosummary/toqito.matrix_props.is_commuting.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_commuting
+==================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_commuting
diff --git a/docs/_autosummary/toqito.matrix_props.is_density.rst b/docs/_autosummary/toqito.matrix_props.is_density.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_density
+================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_density
diff --git a/docs/_autosummary/toqito.matrix_props.is_diagonal.rst b/docs/_autosummary/toqito.matrix_props.is_diagonal.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_diagonal
+=================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_diagonal
diff --git a/docs/_autosummary/toqito.matrix_props.is_diagonally_dominant.rst b/docs/_autosummary/toqito.matrix_props.is_diagonally_dominant.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_diagonally\_dominant
+=============================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_diagonally_dominant
diff --git a/docs/_autosummary/toqito.matrix_props.is_hermitian.rst b/docs/_autosummary/toqito.matrix_props.is_hermitian.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_hermitian
+==================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_hermitian
diff --git a/docs/_autosummary/toqito.matrix_props.is_idempotent.rst b/docs/_autosummary/toqito.matrix_props.is_idempotent.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_idempotent
+===================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_idempotent
diff --git a/docs/_autosummary/toqito.matrix_props.is_identity.rst b/docs/_autosummary/toqito.matrix_props.is_identity.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_identity
+=================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_identity
diff --git a/docs/_autosummary/toqito.matrix_props.is_normal.rst b/docs/_autosummary/toqito.matrix_props.is_normal.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_normal
+===============================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_normal
diff --git a/docs/_autosummary/toqito.matrix_props.is_orthonormal.rst b/docs/_autosummary/toqito.matrix_props.is_orthonormal.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_orthonormal
+====================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_orthonormal
diff --git a/docs/_autosummary/toqito.matrix_props.is_permutation.rst b/docs/_autosummary/toqito.matrix_props.is_permutation.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_permutation
+====================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_permutation
diff --git a/docs/_autosummary/toqito.matrix_props.is_positive_definite.rst b/docs/_autosummary/toqito.matrix_props.is_positive_definite.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_positive\_definite
+===========================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_positive_definite
diff --git a/docs/_autosummary/toqito.matrix_props.is_positive_semidefinite.rst b/docs/_autosummary/toqito.matrix_props.is_positive_semidefinite.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_positive\_semidefinite
+===============================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_positive_semidefinite
diff --git a/docs/_autosummary/toqito.matrix_props.is_projection.rst b/docs/_autosummary/toqito.matrix_props.is_projection.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_projection
+===================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_projection
diff --git a/docs/_autosummary/toqito.matrix_props.is_square.rst b/docs/_autosummary/toqito.matrix_props.is_square.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_square
+===============================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_square
diff --git a/docs/_autosummary/toqito.matrix_props.is_symmetric.rst b/docs/_autosummary/toqito.matrix_props.is_symmetric.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_symmetric
+==================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_symmetric
diff --git a/docs/_autosummary/toqito.matrix_props.is_unitary.rst b/docs/_autosummary/toqito.matrix_props.is_unitary.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.is\_unitary
+================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: is_unitary
diff --git a/docs/_autosummary/toqito.matrix_props.majorizes.rst b/docs/_autosummary/toqito.matrix_props.majorizes.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.majorizes
+==============================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: majorizes
diff --git a/docs/_autosummary/toqito.matrix_props.sk_operator_norm.rst b/docs/_autosummary/toqito.matrix_props.sk_operator_norm.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.sk\_operator\_norm
+=======================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: sk_operator_norm
diff --git a/docs/_autosummary/toqito.matrix_props.trace_norm.rst b/docs/_autosummary/toqito.matrix_props.trace_norm.rst
@@ -0,0 +1,6 @@
+toqito.matrix\_props.trace\_norm
+================================
+
+.. currentmodule:: toqito.matrix_props
+
+.. autofunction:: trace_norm
diff --git a/docs/_autosummary/toqito.state_metrics.bures_angle.rst b/docs/_autosummary/toqito.state_metrics.bures_angle.rst
@@ -1,5 +1,5 @@
-toqito.state\_metrics.bures\_angle
-=====================================
+toqito.state\_metrics.bures\_angle
+==================================
 
 .. currentmodule:: toqito.state_metrics
 

diff --git a/docs/_autosummary/toqito.state_metrics.fidelity_of_separability.rst b/docs/_autosummary/toqito.state_metrics.fidelity_of_separability.rst
@@ -0,0 +1,6 @@
+toqito.state\_metrics.fidelity\_of\_separability
+================================================
+
+.. currentmodule:: toqito.state_metrics
+
+.. autofunction:: fidelity_of_separability
diff --git a/docs/_autosummary/toqito.state_props.is_npt.rst b/docs/_autosummary/toqito.state_props.is_npt.rst
@@ -0,0 +1,6 @@
+toqito.state\_props.is\_npt
+===========================
+
+.. currentmodule:: toqito.state_props
+
+.. autofunction:: is_npt
diff --git a/docs/_autosummary/toqito.state_props.is_separable.rst b/docs/_autosummary/toqito.state_props.is_separable.rst
@@ -1,29 +1,6 @@
 toqito.state\_props.is\_separable
 =================================
 
-.. automodule:: toqito.state_props.is_separable
-
-
-
-
-
-
-
-   .. rubric:: Functions
-
-   .. autosummary::
-
-      is_separable
-
-
-
-
-
-
-
-
-
-
-
-
+.. currentmodule:: toqito.state_props
 
+.. autofunction:: is_separable