diff --git a/docs/conf.py b/docs/conf.py index 874c974bd406..2f90b84e4816 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -190,4 +190,3 @@ def setup(app): app.setup_extension("versionutils") app.connect("build-finished", custom_extensions.clean_api_source) app.connect("build-finished", custom_extensions.clean_tutorials) - app.connect("source-read", custom_extensions.deprecate_ibmq_provider) diff --git a/docs/custom_extensions.py b/docs/custom_extensions.py index 826d3a66a9dd..3e199d985792 100644 --- a/docs/custom_extensions.py +++ b/docs/custom_extensions.py @@ -20,7 +20,7 @@ from distutils import dir_util # Elements with api doc sources -qiskit_elements = ["qiskit-terra", "qiskit-ibmq-provider"] +qiskit_elements = ["qiskit-terra"] apidocs_exists = False apidocs_master = None @@ -125,13 +125,3 @@ def clean_tutorials(app, exc): """Deletes the Git cloned tutorials repo used for doc generation.""" tutorials_dir = os.path.join(app.srcdir, "tutorials") shutil.rmtree(tutorials_dir) - - -def deprecate_ibmq_provider(app, docname, source): - """Adds a deprecation message to the top of every qiskit-ibmq-provider page.""" - message = """.. warning:: - The package ``qiskit-ibmq-provider`` is being deprecated and its repo is going to be - archived soon. Please transition to the new packages. More information in - https://ibm.biz/provider_migration_guide\n\n""" - if "apidoc/ibmq" in docname or "qiskit.providers.ibmq" in docname: - source[0] = message + source[0] diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 99d3f3274d95..0c5275bcc86a 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -129,9 +129,6 @@ going to run and install the packages. There are three main ways to do this: #. :ref:`qiskit-terra ` #. :ref:`qiskit-aer ` - #. :ref:`qiskit-ibmq-provider ` - (if you want to connect to the IBM Quantum devices or online - simulator) To work with several components and elements simultaneously, use the following steps for each element. @@ -230,23 +227,6 @@ going to run and install the packages. There are three main ways to do this: python examples/python/using_qiskit_terra_level_0.py - .. note:: - - If you do not intend to install any other components, qiskit-terra will - emit a ``RuntimeWarning`` warning that both qiskit-aer and - qiskit-ibmq-provider are not installed. This is done because - users commonly intend to use the additional elements, - but do not realize they are not installed, or that the installation - of either Aer or the IBM Quantum Provider failed for some reason. If you wish - to suppress these warnings, add:: - - import warnings - warnings.filterwarnings('ignore', category=RuntimeWarning, - module='qiskit') - - before any ``qiskit`` imports in your code. This will suppress the - warning about the missing qiskit-aer and qiskit-ibmq-provider, but - will continue to display any other warnings from qiskit or other packages. .. _install-qiskit-aer: @@ -450,45 +430,6 @@ going to run and install the packages. There are three main ways to do this: because they are commonly used in the environment. Refer to the tool documentation for more information. - .. _install-qiskit-ibmq-provider: - - .. raw:: html - -

Installing IBM Quantum Provider from Source

- - 1. Clone the qiskit-ibmq-provider repository. - - .. code:: text - - git clone https://github.com/Qiskit/qiskit-ibmq-provider.git - - 2. Cloning the repository creates a local directory called ``qiskit-ibmq-provider``. - - .. code:: text - - cd qiskit-ibmq-provider - - 3. If you want to run tests or linting checks, install the developer requirements. - This is not required to install or use the qiskit-ibmq-provider package when - installing from source. - - .. code:: text - - pip install -r requirements-dev.txt - - 4. Install qiskit-ibmq-provider. - - .. code:: text - - pip install . - - If you want to install it in editable mode, meaning that code changes to the - project don't require a reinstall to be applied: - - .. code:: text - - pip install -e . - .. _platform_support: Platform Support diff --git a/docs/index.rst b/docs/index.rst index fbef3389b5a9..421e4ed03699 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -138,4 +138,4 @@ Interested in quantum hardware design? :hidden: Qiskit Aer - Qiskit IBM Quantum Provider (deprecated) + Qiskit IBM Quantum Provider (deprecated)