diff --git a/README.md b/README.md index e474b910e..cea74cad4 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ provider = IBMProvider(token='MY_API_TOKEN') ## Next Steps Now you're set up and ready to check out some of the tutorials. -- [Qiskit IBM Provider] +- [IBM Quantum Learning] - [Qiskit] ## Contribution Guidelines @@ -111,7 +111,7 @@ project at different levels. If you use Qiskit, please cite as per the included [Stack Exchange]: https://quantumcomputing.stackexchange.com/questions/tagged/qiskit [Qiskit Tutorial]: https://github.com/Qiskit/qiskit-tutorial [many people]: https://github.com/Qiskit/qiskit-ibm-provider/graphs/contributors -[Qiskit IBM Provider]: https://github.com/Qiskit/qiskit-ibm-provider/tree/main/docs/tutorials +[IBM Quantum Learning]: https://learning.quantum.ibm.com/catalog/tutorials [Qiskit]: https://github.com/Qiskit/qiskit-tutorial [BibTeX file]: https://github.com/Qiskit/qiskit/blob/master/Qiskit.bib [Apache License 2.0]: https://github.com/Qiskit/qiskit-ibm-provider/blob/main/LICENSE.txt diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst index e4d661a00..471c0f6c8 100644 --- a/docs/_templates/autosummary/class.rst +++ b/docs/_templates/autosummary/class.rst @@ -12,38 +12,25 @@ :no-inherited-members: :no-special-members: - {% block attributes_summary %} +{% block attributes_summary %} {% if attributes %} - .. rubric:: Attributes - - .. autosummary:: - :toctree: ../stubs/ - {% for item in all_attributes %} - {%- if not item.startswith('_') %} - {{ name }}.{{ item }} - {%- endif -%} - {%- endfor %} + {% for item in all_attributes %} + {%- if not item.startswith('_') %} + .. autoattribute:: {{ name }}.{{ item }} + {%- endif -%} + {%- endfor %} {% endif %} - {% endblock %} +{% endblock %} - {% block methods_summary %} +{% block methods_summary %} {% if methods %} - .. rubric:: Methods - - .. autosummary:: - :toctree: ../stubs/ {% for item in all_methods %} {%- if not item.startswith('_') or item in ['__call__', '__mul__', '__getitem__', '__len__'] %} - {{ name }}.{{ item }} - {%- endif -%} - {%- endfor %} - {% for item in inherited_members %} - {%- if item in ['__call__', '__mul__', '__getitem__', '__len__'] %} - {{ name }}.{{ item }} + .. automethod:: {{ name }}.{{ item }} {%- endif -%} {%- endfor %} {% endif %} - {% endblock %} +{% endblock %} diff --git a/qiskit_ibm_provider/ibm_backend.py b/qiskit_ibm_provider/ibm_backend.py index 613284323..25f5af367 100644 --- a/qiskit_ibm_provider/ibm_backend.py +++ b/qiskit_ibm_provider/ibm_backend.py @@ -593,7 +593,7 @@ def properties( The schema for backend properties can be found in `Qiskit/ibm-quantum-schemas - `_. + `__. Args: refresh: If ``True``, re-query the server for the backend properties. @@ -665,7 +665,7 @@ def defaults(self, refresh: bool = False) -> Optional[PulseDefaults]: The schema for default pulse configuration can be found in `Qiskit/ibm-quantum-schemas - `_. + `__. Args: refresh: If ``True``, re-query the server for the backend pulse defaults. @@ -695,7 +695,7 @@ def configuration( The schema for backend configuration can be found in `Qiskit/ibm-quantum-schemas - `_. + `__. Returns: The configuration for the backend. diff --git a/requirements.txt b/requirements.txt index 5a7e211d1..c3ed892af 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -qiskit>=0.45.0 +qiskit>=0.45.0,<1 requests>=2.19 requests_ntlm>=1.1.0 numpy>=1.13