Skip to content

Docathon! Docs for discrete pulse functions #3838

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

Merged
mergify merged 16 commits into from
Feb 14, 2020
Merged

Docathon! Docs for discrete pulse functions #3838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
bace190
adding math functions to doc strings in discrete.py, and messing with…
DanPuzzuoli Feb 13, 2020
350cedd
further work on function documentation
DanPuzzuoli Feb 13, 2020
981b8a9
completed another pass of discrete.py fixing sphinx issues
DanPuzzuoli Feb 13, 2020
d1c585c
Updated pulse.rst and pulse/__init__.py to include docs correctly as …
DanPuzzuoli Feb 13, 2020
51f3891
reshuffling sphinx toc stuff
DanPuzzuoli Feb 13, 2020
8170875
de-indented the second two lines in citation to avoid the 'header' st…
DanPuzzuoli Feb 14, 2020
4902090
Update qiskit/pulse/pulse_lib/discrete.py
DanPuzzuoli Feb 14, 2020
240cc96
Update qiskit/pulse/pulse_lib/discrete.py
DanPuzzuoli Feb 14, 2020
c49109b
Update qiskit/pulse/pulse_lib/discrete.py
DanPuzzuoli Feb 14, 2020
b53e07d
re-adding doc string to pulse_lib/__init__.py
DanPuzzuoli Feb 14, 2020
54919be
fixed one more error in the drag function- mathematical description d…
DanPuzzuoli Feb 14, 2020
cae345c
Update qiskit/pulse/__init__.py
DanPuzzuoli Feb 14, 2020
c96477f
Update qiskit/pulse/pulse_lib/discrete.py
DanPuzzuoli Feb 14, 2020
c0702ca
Update qiskit/pulse/pulse_lib/discrete.py
DanPuzzuoli Feb 14, 2020
c5db6bc
Merge branch 'master' into pulse-lib-doc-2
mergify[bot] Feb 14, 2020
69c3bbb
Merge branch 'master' into pulse-lib-doc-2
mergify[bot] Feb 14, 2020
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
8 changes: 8 additions & 0 deletions qiskit/pulse/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,14 @@
LoConfig
LoRange

Pulse Library
=============

.. autosummary::
:toctree: ../stubs/

~qiskit.pulse.pulse_lib.discrete

Exceptions
==========

Expand Down
2 changes: 1 addition & 1 deletion qiskit/pulse/pulse_lib/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@
# copyright notice, and modified files need to carry a notice indicating
# that they have been altered from the originals.

"""Module for builtin pulse_lib."""
"""Module for builtin ``pulse_lib``."""

from .discrete import *
Loading