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.

Sign up for GitHub

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

Jump to bottom

Tidy up pytket.circuit API docs #1178

Merged
merged 45 commits into from
Jan 29, 2024
Merged

Tidy up pytket.circuit API docs #1178

Show file tree
Hide file tree
Changes from 30 commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
aa81203
don't clutter pytket.circuit docs by expanding submodules
CalMacCQ Dec 14, 2023
b4d74de
change caption
CalMacCQ Dec 14, 2023
c11c4ca
use bysource order for autodoc
CalMacCQ Dec 14, 2023
0104fe8
start using automethod for Circuit methods
CalMacCQ Dec 14, 2023
6a57997
fix typo
CalMacCQ Dec 14, 2023
2dcbb37
use autodoc typehints
CalMacCQ Dec 14, 2023
e146082
Expand TOC for all pages
CalMacCQ Dec 14, 2023
cd31ca4
add some circuit properties
CalMacCQ Dec 14, 2023
66a0c5b
delete unused config settings
CalMacCQ Dec 15, 2023
009d4af
add another chunk of automethod boilerplate
CalMacCQ Dec 15, 2023
68e5bc7
finish adding circuit methods
CalMacCQ Dec 15, 2023
12cd295
add some notes on Circuit.add_gate
CalMacCQ Dec 15, 2023
f52971f
submodules -> classes
CalMacCQ Dec 15, 2023
104e196
scrub ._tket from pytket.circuit docs source
CalMacCQ Dec 15, 2023
3357da1
remove more _tket
CalMacCQ Dec 15, 2023
d182291
don't use sphinx_autodoc_typehints for now
CalMacCQ Dec 15, 2023
134e6cd
remove non-existent Reset method
CalMacCQ Dec 15, 2023
00d9e7e
use submodules rather than classes
CalMacCQ Dec 15, 2023
4c45c85
don't show binary info in pytket.circuit doc
CalMacCQ Dec 15, 2023
dad668e
remove typehints extension entirely
CalMacCQ Dec 15, 2023
4b31411
remove duplicate CV method
CalMacCQ Dec 15, 2023
b5a5270
remove more duplicate methods
CalMacCQ Dec 15, 2023
c6c46d1
submodules -> classes
CalMacCQ Jan 22, 2024
78de3d4
reorder circuit properties
CalMacCQ Jan 22, 2024
e587ae1
remove duplicate properties
CalMacCQ Jan 22, 2024
f384377
remove :special-members: and use automethod for __init__ etc
CalMacCQ Jan 22, 2024
5713962
Merge branch 'develop' into docs/tidy_pytket.circuit
CalMacCQ Jan 22, 2024
3d992b7
remove __hash__
CalMacCQ Jan 22, 2024
abe76a4
minor spacing edit
CalMacCQ Jan 22, 2024
7b0df5c
Revert "minor spacing edit"
CalMacCQ Jan 22, 2024
4796185
add missing methods found by python script
CalMacCQ Jan 22, 2024
126a707
Merge branch 'develop' into docs/tidy_pytket.circuit
CalMacCQ Jan 22, 2024
53206d3
use autoproperty for created_qubits and discarded_qubits
CalMacCQ Jan 22, 2024
62a2508
add script to check circuit methods and properties
CalMacCQ Jan 23, 2024
278e8b5
fix typo
CalMacCQ Jan 23, 2024
618c36d
remove comment
CalMacCQ Jan 23, 2024
a06c9b4
fix spaxing and heading
CalMacCQ Jan 23, 2024
69382b3
consistent headings
CalMacCQ Jan 23, 2024
f4e259a
remove some dunder methods from API docs
CalMacCQ Jan 23, 2024
9581168
add __rshift__ dunder method back into the docs
CalMacCQ Jan 23, 2024
fa99cb8
Merge branch 'develop' into docs/tidy_pytket.circuit
CalMacCQ Jan 24, 2024
cb09c7b
add explanatory comments
CalMacCQ Jan 25, 2024
36a4265
remove spaces
CalMacCQ Jan 25, 2024
4bc5285
Merge branch 'develop' into docs/tidy_pytket.circuit
CalMacCQ Jan 26, 2024
0a3520b
Merge branch 'develop' into docs/tidy_pytket.circuit
CalMacCQ Jan 29, 2024
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
74 changes: 37 additions & 37 deletions pytket/docs/circuit.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ pytket.circuit
==================================
.. toctree::
:caption: Classes:
:maxdepth: 2
:maxdepth: 1
CalMacCQ marked this conversation as resolved.
Show resolved Hide resolved

circuit_class.rst
optype.rst
Expand All @@ -14,104 +14,104 @@ pytket.circuit

.. automodule:: pytket._tket.circuit
:members: fresh_symbol
.. autoclass:: pytket._tket.circuit.Op
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think all of this _tket stuff is replaced in the docs build anyway. I don't think theres any good reason for it to be in the rst source

.. autoclass:: pytket.circuit.Op
:members:
.. autoclass:: pytket._tket.circuit.Command
.. autoclass:: pytket.circuit.Command
:members:
.. autoclass:: pytket._tket.circuit.BasisOrder
.. autoclass:: pytket.circuit.BasisOrder
:members:
.. autoclass:: pytket._tket.circuit.CircBox
.. autoclass:: pytket.circuit.CircBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.Unitary1qBox
.. autoclass:: pytket.circuit.Unitary1qBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.Unitary2qBox
.. autoclass:: pytket.circuit.Unitary2qBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.Unitary3qBox
.. autoclass:: pytket.circuit.Unitary3qBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.ExpBox
.. autoclass:: pytket.circuit.ExpBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.PauliExpBox
.. autoclass:: pytket.circuit.PauliExpBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.PauliExpPairBox
.. autoclass:: pytket.circuit.PauliExpPairBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.ToffoliBox
.. autoclass:: pytket.circuit.ToffoliBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.QControlBox
.. autoclass:: pytket.circuit.QControlBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.CustomGateDef
.. autoclass:: pytket.circuit.CustomGateDef
:members:
.. autoclass:: pytket._tket.circuit.CustomGate
.. autoclass:: pytket.circuit.CustomGate
:members:
.. autoclass:: pytket._tket.circuit.Conditional
.. autoclass:: pytket.circuit.Conditional
:members:
.. autoclass:: pytket._tket.circuit.ClassicalExpBox
.. autoclass:: pytket.circuit.ClassicalExpBox
:members:
.. autoclass:: pytket._tket.circuit.PhasePolyBox
.. autoclass:: pytket.circuit.PhasePolyBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.ProjectorAssertionBox
.. autoclass:: pytket.circuit.ProjectorAssertionBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.StabiliserAssertionBox
.. autoclass:: pytket.circuit.StabiliserAssertionBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.WASMOp
.. autoclass:: pytket.circuit.WASMOp
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.MultiBitOp
.. autoclass:: pytket.circuit.MultiBitOp
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.SetBitsOp
.. autoclass:: pytket.circuit.SetBitsOp
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.ClassicalEvalOp
.. autoclass:: pytket.circuit.ClassicalEvalOp
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.ClassicalOp
.. autoclass:: pytket.circuit.ClassicalOp
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.CopyBitsOp
.. autoclass:: pytket.circuit.CopyBitsOp
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.RangePredicateOp
.. autoclass:: pytket.circuit.RangePredicateOp
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.MultiplexorBox
.. autoclass:: pytket.circuit.MultiplexorBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.MultiplexedRotationBox
.. autoclass:: pytket.circuit.MultiplexedRotationBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.MultiplexedU2Box
.. autoclass:: pytket.circuit.MultiplexedU2Box
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.MultiplexedTensoredU2Box
.. autoclass:: pytket.circuit.MultiplexedTensoredU2Box
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.StatePreparationBox
.. autoclass:: pytket.circuit.StatePreparationBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.DiagonalBox
.. autoclass:: pytket.circuit.DiagonalBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.ConjugationBox
.. autoclass:: pytket.circuit.ConjugationBox
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.ResourceBounds
.. autoclass:: pytket.circuit.ResourceBounds
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.ResourceData
.. autoclass:: pytket.circuit.ResourceData
:special-members:
:members:
.. autoclass:: pytket._tket.circuit.DummyBox
.. autoclass:: pytket.circuit.DummyBox
:special-members:
:members:
Loading
Loading