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

Move methods into class pages for docs #1144

Merged
merged 3 commits into from
Oct 17, 2023
Merged

Move methods into class pages for docs #1144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c990f1c
Move methods into class pages for docs
arnaucasau Oct 11, 2023
fbdd7f1
Merge branch 'main' into no-method-pages
arnaucasau Oct 17, 2023
7a1a349
Merge branch 'main' into no-method-pages
arnaucasau Oct 17, 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
10 changes: 3 additions & 7 deletions docs/_templates/autosummary/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,9 @@

.. rubric:: Attributes

.. autosummary::
:toctree: ../stubs/
{% for item in all_attributes %}
{%- if not item.startswith('_') %}
{{ name }}.{{ item }}
.. autoattribute:: {{ name }}.{{ item }}
{%- endif -%}
{%- endfor %}
{% endif %}
Expand All @@ -32,16 +30,14 @@

.. rubric:: Methods

.. autosummary::
:toctree: ../stubs/
{% for item in all_methods %}
{%- if not item.startswith('_') or item in ['__call__', '__mul__', '__getitem__', '__len__'] %}
{{ name }}.{{ item }}
.. automethod:: {{ name }}.{{ item }}
{%- endif -%}
{%- endfor %}
{% for item in inherited_members %}
{%- if item in ['__call__', '__mul__', '__getitem__', '__len__'] %}
{{ name }}.{{ item }}
.. automethod:: {{ name }}.{{ item }}
{%- endif -%}
{%- endfor %}

Expand Down
6 changes: 3 additions & 3 deletions qiskit_ibm_runtime/ibm_backend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ def properties(
properties of the backend.

The schema for backend properties can be found in
`Qiskit/ibm-quantum-schemas
`Qiskit/ibm-quantum-schemas/backend_properties
<https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_properties_schema.json>`_.

Args:
Expand Down Expand Up @@ -410,7 +410,7 @@ def defaults(self, refresh: bool = False) -> Optional[PulseDefaults]:
"""Return the pulse defaults for the backend.

The schema for default pulse configuration can be found in
`Qiskit/ibm-quantum-schemas
`Qiskit/ibm-quantum-schemas/default_pulse_configuration
<https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/default_pulse_configuration_schema.json>`_.

Args:
Expand Down Expand Up @@ -438,7 +438,7 @@ def configuration(
as its name, number of qubits, basis gates, coupling map, quantum volume, etc.

The schema for backend configuration can be found in
`Qiskit/ibm-quantum-schemas
`Qiskit/ibm-quantum-schemas/backend_configuration
<https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_configuration_schema.json>`_.

Returns:
Expand Down
Loading