Skip to content

Add missing API Refs to docs #1343

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
Eric-Arellano merged 6 commits into from
Jan 29, 2024
Merged

Add missing API Refs to docs #1343

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f07775b
Create transpiler.rst
beckykd Jan 22, 2024
72da146
Create fake_provider.rst
beckykd Jan 22, 2024
04a348c
Update ibm-runtime.rst
beckykd Jan 22, 2024
ba3dfad
Add matplotlib directive to build docs
kaelynj Jan 26, 2024
03d376e
Merge branch 'main' into bd-add-missing-api-docs
kaelynj Jan 26, 2024
d768c0a
Merge branch 'main' into bd-add-missing-api-docs
Eric-Arellano 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
4 changes: 4 additions & 0 deletions docs/apidocs/fake_provider.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.. automodule:: qiskit_ibm_runtime.fake_provider
Comment thread
Eric-Arellano marked this conversation as resolved.
:no-members:
:no-inherited-members:
:no-special-members:
2 changes: 2 additions & 0 deletions docs/apidocs/ibm-runtime.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ qiskit-ibm-runtime API reference

runtime_service
options
transpiler
fake_provider
4 changes: 4 additions & 0 deletions docs/apidocs/transpiler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.. automodule:: qiskit_ibm_runtime.transpiler
:no-members:
:no-inherited-members:
:no-special-members:
1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
'reno.sphinxext',
'nbsphinx',
'sphinxcontrib.katex',
'matplotlib.sphinxext.plot_directive',
]
templates_path = ['_templates']

Expand Down
4 changes: 2 additions & 2 deletions qiskit_ibm_runtime/fake_provider/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
# that they have been altered from the originals.

"""
======================================================
=======================================================
Fake Provider (:mod:`qiskit_ibm_runtime.fake_provider`)
======================================================
=======================================================

.. currentmodule:: qiskit_ibm_runtime.fake_provider

Expand Down