Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move references in docstrings #228

Merged
merged 43 commits into from
Nov 25, 2023
Merged
Show file tree
Hide file tree
Changes from 38 commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
09aaf29
change sphinx sphinx-rtd-theme
purva-thakre Nov 10, 2023
35b201c
test autosummary additions
purva-thakre Nov 10, 2023
c8d667f
bibtex scaffolding
purva-thakre Nov 17, 2023
398ceaf
disable duplicate label key warnings
purva-thakre Nov 17, 2023
cbcfb8a
ref: channel_metrics
purva-thakre Nov 19, 2023
f381bbc
random to rand
purva-thakre Nov 19, 2023
773af44
all: docname in docnames
purva-thakre Nov 20, 2023
2eaa66c
refs: channel_ops
purva-thakre Nov 20, 2023
0ca4473
refs: channel_props
purva-thakre Nov 20, 2023
1de757b
refs: channels
purva-thakre Nov 21, 2023
45e91b3
refs: helper
purva-thakre Nov 21, 2023
e232abc
refs: matrices
purva-thakre Nov 21, 2023
7533dfa
refs: matrix_ops
purva-thakre Nov 21, 2023
e44dc17
refs: matrix_props
purva-thakre Nov 21, 2023
af12618
refs: measurement_ops
purva-thakre Nov 21, 2023
bd92169
refs: measurement_props
purva-thakre Nov 21, 2023
51ef719
refs: nonlocal_games
purva-thakre Nov 21, 2023
5413836
refs: perms
purva-thakre Nov 21, 2023
d3ede6f
refs: rand
purva-thakre Nov 21, 2023
dd91a88
refs: state_metrics
purva-thakre Nov 22, 2023
853a37f
refs: state_ops
purva-thakre Nov 22, 2023
3c69a15
refs: state_opt
purva-thakre Nov 22, 2023
8d33a5a
refs: state_props
purva-thakre Nov 22, 2023
e5fe07e
refs: states
purva-thakre Nov 22, 2023
b6ce85a
build errors
purva-thakre Nov 22, 2023
c68623c
linter
purva-thakre Nov 22, 2023
c9727f0
bibtex error
purva-thakre Nov 23, 2023
ea9fc95
Merge branch 'master' into move_docstring_ref
purva-thakre Nov 23, 2023
79e59bd
fix https://github.com/vprusso/toqito/pull/228#discussion_r1397772174…
purva-thakre Nov 23, 2023
d0b1998
pydocstyle errors
purva-thakre Nov 23, 2023
6a141af
Merge branch 'master' into move_docstring_ref
purva-thakre Nov 24, 2023
6506ead
Apply suggestions from code review
purva-thakre Nov 24, 2023
1dd4374
indent
purva-thakre Nov 24, 2023
7820df1
rigetti docs to rigetti forest
purva-thakre Nov 24, 2023
8cefa8f
capitalize section/chapter titles from watrous textbook
purva-thakre Nov 24, 2023
2a6c62c
Fix https://github.com/vprusso/toqito/pull/228#discussion_r1404576718
purva-thakre Nov 24, 2023
6280594
one link for qetlab
purva-thakre Nov 24, 2023
1ab5de9
change key style
purva-thakre Nov 24, 2023
c5d0a15
consistent bibtex key style
purva-thakre Nov 25, 2023
c6df2b6
month
purva-thakre Nov 25, 2023
1db6874
author: last name, first name
purva-thakre Nov 25, 2023
954bf51
Merge branch 'master' into move_docstring_ref
purva-thakre Nov 25, 2023
2d41cf2
check all docstrings
purva-thakre Nov 25, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.channel\_metrics.completely\_bounded\_spectral\_norm
===========================================================

.. currentmodule:: toqito.channel_metrics

.. autofunction:: completely_bounded_spectral_norm
purva-thakre marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.channel\_metrics.completely\_bounded\_trace\_norm
========================================================

.. currentmodule:: toqito.channel_metrics

.. autofunction:: completely_bounded_trace_norm
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.channel\_metrics.fidelity\_of\_separability
==================================================

.. currentmodule:: toqito.channel_metrics

.. autofunction:: fidelity_of_separability
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrices.clock.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrices.clock
=====================

.. currentmodule:: toqito.matrices

.. autofunction:: clock
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrices.cnot.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrices.cnot
====================

.. currentmodule:: toqito.matrices

.. autofunction:: cnot
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrices.fourier.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrices.fourier
=======================

.. currentmodule:: toqito.matrices

.. autofunction:: fourier
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrices.gell_mann.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrices.gell\_mann
==========================

.. currentmodule:: toqito.matrices

.. autofunction:: gell_mann
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrices.gen_gell_mann.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrices.gen\_gell\_mann
===============================

.. currentmodule:: toqito.matrices

.. autofunction:: gen_gell_mann
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrices.gen_pauli.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrices.gen\_pauli
==========================

.. currentmodule:: toqito.matrices

.. autofunction:: gen_pauli
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrices.hadamard.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrices.hadamard
========================

.. currentmodule:: toqito.matrices

.. autofunction:: hadamard
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrices.pauli.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrices.pauli
=====================

.. currentmodule:: toqito.matrices

.. autofunction:: pauli
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrices.shift.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrices.shift
=====================

.. currentmodule:: toqito.matrices

.. autofunction:: shift
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrices.standard_basis.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrices.standard\_basis
===============================

.. currentmodule:: toqito.matrices

.. autofunction:: standard_basis
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_ops.inner_product.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_ops.inner\_product
=================================

.. currentmodule:: toqito.matrix_ops

.. autofunction:: inner_product
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_ops.outer_product.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_ops.outer\_product
=================================

.. currentmodule:: toqito.matrix_ops

.. autofunction:: outer_product
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_ops.tensor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_ops.tensor
=========================

.. currentmodule:: toqito.matrix_ops

.. autofunction:: tensor
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_ops.unvec.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_ops.unvec
========================

.. currentmodule:: toqito.matrix_ops

.. autofunction:: unvec
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_ops.vec.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_ops.vec
======================

.. currentmodule:: toqito.matrix_ops

.. autofunction:: vec
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_ops.vectors\_from\_gram\_matrix
==============================================

.. currentmodule:: toqito.matrix_ops

.. autofunction:: vectors_from_gram_matrix
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_ops.vectors\_to\_gram\_matrix
============================================

.. currentmodule:: toqito.matrix_ops

.. autofunction:: vectors_to_gram_matrix
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.is_block_positive.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_block\_positive
========================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_block_positive
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.is_circulant.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_circulant
==================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_circulant
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.is_commuting.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_commuting
==================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_commuting
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.is_density.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_density
================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_density
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.is_diagonal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_diagonal
=================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_diagonal
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_diagonally\_dominant
=============================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_diagonally_dominant
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.is_hermitian.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_hermitian
==================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_hermitian
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.is_idempotent.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_idempotent
===================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_idempotent
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.is_identity.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_identity
=================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_identity
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.is_normal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_normal
===============================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_normal
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.is_orthonormal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_orthonormal
====================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_orthonormal
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.is_permutation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_permutation
====================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_permutation
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_positive\_definite
===========================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_positive_definite
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_positive\_semidefinite
===============================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_positive_semidefinite
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.is_projection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_projection
===================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_projection
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.is_square.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_square
===============================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_square
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.is_symmetric.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_symmetric
==================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_symmetric
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.is_unitary.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.is\_unitary
================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: is_unitary
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.kp_norm.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.kp\_norm
=============================

.. currentmodule:: toqito.matrix_props

.. autofunction:: kp_norm
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.majorizes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.majorizes
==============================

.. currentmodule:: toqito.matrix_props

.. autofunction:: majorizes
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.sk_operator_norm.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.sk\_operator\_norm
=======================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: sk_operator_norm
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.matrix_props.trace_norm.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.matrix\_props.trace\_norm
================================

.. currentmodule:: toqito.matrix_props

.. autofunction:: trace_norm
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
toqito.rand.random\_density\_matrix
=====================================
===================================

.. currentmodule:: toqito.rand

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
toqito.rand.random\_ginibre
=============================
===========================

.. currentmodule:: toqito.rand

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
toqito.rand.random\_povm
==========================
========================

.. currentmodule:: toqito.rand

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
toqito.rand.random\_state\_vector
===================================
=================================

.. currentmodule:: toqito.rand

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
toqito.rand.random\_unitary
=============================
===========================

.. currentmodule:: toqito.rand

Expand Down
4 changes: 2 additions & 2 deletions docs/_autosummary/toqito.state_metrics.bures_angle.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
toqito.state\_metrics.bures\_angle
=====================================
toqito.state\_metrics.bures\_angle
==================================

.. currentmodule:: toqito.state_metrics

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.state\_metrics.fidelity\_of\_separability
================================================

.. currentmodule:: toqito.state_metrics

.. autofunction:: fidelity_of_separability
6 changes: 6 additions & 0 deletions docs/_autosummary/toqito.state_props.is_npt.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
toqito.state\_props.is\_npt
===========================

.. currentmodule:: toqito.state_props

.. autofunction:: is_npt
Loading