Merge branch 'main' into main

CONTRIBUTING.md

@@ -1,5 +1,5 @@
 # Contributing to Qiskit Metal
-Qiskit Metal follows the overall Qiskit project contributing guidelines. These are all included in the [Qiskit Documentation](https://qiskit.org/documentation/contributing_to_qiskit.html).
+Qiskit Metal follows the overall Qiskit project contributing guidelines. These are all included in the [Qiskit Documentation](https://github.com/Qiskit/qiskit/blob/main/CONTRIBUTING.md).
 
 Please read those general guidelines first, then the specific details for contributing to Metal below.
 

README.md

@@ -5,7 +5,7 @@
 > Qiskit Metal is an open-source framework for engineers and scientists to design superconducting quantum devices with ease.
 
 ## Installation
-If you are interested in customizing your experience, or if you are unable to install qiskit-metal using the `pip install` instructions below, consider installing directly the source code, following the instructions in the [documentation](https://qiskit.org/documentation/metal/installation.html) and/or the [installation instructions for developers](https://github.com/Qiskit/qiskit-metal/blob/main/README_developers.md).
+If you are interested in customizing your experience, or if you are unable to install qiskit-metal using the `pip install` instructions below, consider installing directly the source code, following the instructions in the [documentation](https://qiskit-community.github.io/qiskit-metal/installation.html) and/or the [installation instructions for developers](https://github.com/Qiskit/qiskit-metal/blob/main/README_developers.md).
 
 For normal use, please continue reading.
 
@@ -16,7 +16,7 @@ pip install qiskit-metal
 ```
 PIP will handle most of the dependencies automatically and you will always install the latest (and well-tested) version of the package.
 
-Some of the dependencies, namely pyside2 and geopandas, might require manual installation, depending on your specific system compatibility. If you encounter installation or execution errors, please refer first to the [FAQ](https://qiskit.org/documentation/metal/faq.html).
+Some of the dependencies, namely pyside2 and geopandas, might require manual installation, depending on your specific system compatibility. If you encounter installation or execution errors, please refer first to the [FAQ](https://qiskit-community.github.io/qiskit-metal/faq.html).
 
 We recommend to install qiskit-metal in a conda environment or venv, to prevent version conflicts with pre-existing package versions.
 
@@ -25,7 +25,7 @@ At this time, we recommend using Jupyter notebook/lab to be able to access all t
 
 If you require a fresh installation, please refer to either [anaconda.org](https://anaconda.org/) or [jupyter.org](https://jupyter.org/install).
 
-Unless you installed the entire `jupyter` package in your current environment, do not forget to create the appropriate kernel to make the environment (thus qiskit-metal) available to jupyter (instructions in the [FAQ](https://qiskit.org/documentation/metal/faq.html))
+Unless you installed the entire `jupyter` package in your current environment, do not forget to create the appropriate kernel to make the environment (thus qiskit-metal) available to jupyter (instructions in the [FAQ](https://qiskit-community.github.io/qiskit-metal/faq.html))
 
 ## Creating Your First Quantum Component in Qiskit Metal:
 Now that Qiskit Metal is installed, it's time to begin working with it.
@@ -78,7 +78,7 @@ $ python
 >>> gui.main_window.close()
 ```
 
-A script is available [here](https://qiskit.org/documentation/metal/tut/overview/1.1%20High%20Level%20Demo%20of%20Qiskit%20Metal.html), where we also show the overview of Qiskit Metal.
+A script is available [here](https://qiskit-community.github.io/qiskit-metal/tut/overview/1.1%20High%20Level%20Demo%20of%20Qiskit%20Metal.html), where we also show the overview of Qiskit Metal.
 
 ## Community and Support
 
@@ -104,7 +104,7 @@ and use our [Qiskit Slack channel](https://qiskit.slack.com) for discussion and
 For questions that are more suited for a forum we use the Qiskit tag in the [Stack Exchange](https://quantumcomputing.stackexchange.com/questions/tagged/qiskit).
 ## Next Steps
 Now you're set up and ready to check out some of the other examples from our
-[Qiskit Metal Tutorials](https://github.com/Qiskit/qiskit-metal/blob/main/tutorials/) repository or [Qiskit Metal Documentation](https://qiskit.org/documentation/metal/tut/).
+[Qiskit Metal Tutorials](https://github.com/Qiskit/qiskit-metal/blob/main/tutorials/) repository or [Qiskit Metal Documentation](https://qiskit-community.github.io/qiskit-metal/tut/).
 ## Authors and Citation
 Qiskit Metal is the work of [many people](https://github.com/Qiskit/qiskit-metal/pulse/monthly) who contribute to the project at different levels. Metal was conceived and developed by [Zlatko Minev](https://www.zlatko-minev.com) at IBM; then co-led with Thomas McConkey. If you use Qiskit Metal, please cite as per the included [BibTeX file](https://github.com/Qiskit/qiskit-metal/blob/main/Qiskit_Metal.bib). For icon attributions, see [here](https://github.com/Qiskit/qiskit-metal/blob/main/qiskit_metal/_gui/_imgs/icon_attributions.txt).
 ## Changelog and Release Notes

README_developers.md

@@ -71,7 +71,7 @@ Similarly, `jupyter lab` will in general execute python code from the `base` env
 
 In the two above cases, you will need to setup a jupyter kernel that points to your `<env_name>` environment, to be able to find and execute successfully the qiskit-metal package.
 
-Check for the instructions to install a new kernel in the [FAQ](https://qiskit.org/documentation/metal/faq.html).
+Check for the instructions to install a new kernel in the [FAQ](https://qiskit-community.github.io/qiskit-metal/faq.html).
 
 #### Subsequent updates of the conda environment
 
@@ -123,7 +123,7 @@ If you want to use the recently added open-source renderers for [Gmsh](./qiskit_
 
 # Other Common Issues
 
-For other common installation issues, please refer to the [FAQ](https://qiskit.org/documentation/metal/faq.html)
+For other common installation issues, please refer to the [FAQ](https://qiskit-community.github.io/qiskit-metal/faq.html)
 
 ## Additional steps for developers
 

docs/contributor-guide.rst

@@ -211,9 +211,7 @@ documentation locally and save the output to ``docs/_build/html``.
 Additionally, the Docs CI job on azure pipelines will run this and host a zip
 file of the output that you can download and view locally.
 
-If you have an issue with the `combined documentation <https://qiskit.org/documentation/>`__
-that is maintained in the `Qiskit/qiskit repo <https://github.com/Qiskit/qiskit>`__,
-you can open a `documentation issue <https://github.com/Qiskit/qiskit/issues/new/choose>`__
+You can open a `documentation issue <https://github.com/qiskit-community/qiskit-metal/issues/new/choose>`__
 if you see doc bugs, have a new feature that needs to be documented, or think
 that material could be added to the existing docs.
 
@@ -399,15 +397,14 @@ and that they want the display name of this file to be ``MyQComponent``.
 Contributing to Documentation
 *****************************
 
-Qiskit documentation is shaped by the `docs as code
+Qiskit Metal documentation is shaped by the `docs as code
 <https://www.writethedocs.org/guide/docs-as-code/>`__ philosophy, primarily
-drawn from Qiskit code comments in the `style of API documentation
+drawn from Qiskit Metal code comments in the `style of API documentation
 <https://alistapart.com/article/the-ten-essentials-for-good-api-documentation/>`__.
 
-The documentation is built from the master branch of `Qiskit/qiskit/docs
-<https://github.com/Qiskit/qiskit/tree/master/docs>`__ using `Sphinx
+The documentation is built using `Sphinx
 <http://www.sphinx-doc.org/en/master/>`__. The majority of documentation, under
-`API Reference <https://qiskit.org/documentation/apidoc/qiskit.html>`__, is
+`API Reference <https://qiskit-community.github.io/qiskit-metal/overview.html>`__, is
 drawn from code comments in the repositories listed in :ref:`where_things_are`.
 
 
@@ -497,82 +494,3 @@ Tutorials
 
 Jupyter notebook tutorials showing off features of Qiskit Metal are located in the `_tutorials_`
 folder. If you add a new feature, please add a demonstration of its use to a notebook or start a new notebook.
-
-
-Documentation Integration
--------------------------
-
-The hosted documentation at https://qiskit.org/documentation/ covers the entire
-Qiskit project; Metal is just one component of that. As such, the documentation
-builds for the hosted version are built by the Qiskit meta-package repository
-https://github.com/Qiskit/qiskit. When commits are merged to that repo, the
-output of Sphinx builds are uploaded to the qiskit.org website. Those Sphinx
-builds are configured to pull in the documentation from the version of the
-Qiskit elements installed by the meta-package at that point. For example, if
-the meta-package version is currently 0.13.0, then that will copy the
-documentation from Metal's 0.10.0 release. When the meta-package's requirements
-are bumped, then it will start pulling documentation from the new version. This
-means that fixes for incorrect API documentation will need to be
-included in a new release. Documentation fixes are valid backports for a stable
-patch release per the stable branch policy (see that section below).
-
-During the build process, the contents of each element's ``docs/apidocs/``
-are recursively copied into a shared copy of ``doc/apidocs/`` in the meta-package
-repository along with all the other elements. This means that what is in the root of
-docs/apidocs on each element at a release will end up on the root of
-https://qiskit.org/documentation/apidoc/.
-
-
-
-Translating Documentation
-=========================
-
-Qiskit documentation is translated (localized) using Crowdin, a software and web
-localization platform that allows organizations to coordinate translation
-projects and collaborate with communities to translate materials. Crowdin allows
-our community of translators to amplify their impact by automatically reusing
-the work invested translating one sentence to translate other, similar
-sentences. Crowdin also makes translations resilient to many types of changes to
-the original material, such as moving sentences around, even across files.
-
-Qiskit localization requests are handled in `Qiskit Translations <https://github.com/Qiskit/qiskit-translations>`__
-repository. To contribute to Qiskit localization, please follow these steps:
-
-#. Add your name (or ID) to the `LOCALIZATION_CONTRIBUTORS
-   <https://github.com/qiskit-community/qiskit-translations/blob/master/LOCALIZATION_CONTRIBUTORS>`__
-   file.
-#. Create a pull request (PR) to merge your change. Make sure to follow the template
-   to open a Pull Request.
-
-   .. note::
-
-      - Each contributor has to create their own PR and sign the CLA.
-      - Please mention the language that you'd like to contribute to in the PR
-        summary.
-      - If you have an open issue for a language request, **add the issue link
-        to the PR**.
-#. You will be asked to sign the Qiskit Contributors License Agreement (CLA);
-   please do so.
-#. A minimum of **three contributors** per language are necessary for any new
-   languages to be added, to receive official support from the administrators of
-   the localization project.
-#. Among the group of contributors, a translation lead must be identified to serve
-   as a liaison with the administrators of the localization project.
-   The lead must contact: Yuri Kobayashi (yurik@jp.ibm.com) by email.
-#. In the `Qiskit-Docs <https://crowdin.com/project/qiskit-docs>`__
-   Crowdin project, choose the language that you want to contribute to.
-
-   .. note::
-
-      As mentioned in the blog post, `Qiskit in my language is Qiskit <https://medium.com/qiskit/qiskit-in-my-language-is-qiskit-73d4626a99d3>`__,
-      we want to make sure that translated languages have enough community support
-      to build a translation team with translators, proofreaders, and translation leads.
-      If you want to be a translation lead or would be willing to join a new
-      translation project team, you can open a `GitHub issue <https://github.com/qiskit-community/qiskit-translations/issues/new/choose>`__
-      to start a discussion with the Qiskit team and recruit translation project members.
-#. Click the **Join** button and **paste the URL of your PR** in the dialog box where you
-   are asked why you want to join the Crowdin project.
-
-The administrators of the Crowdin project will review your request and give you
-access as quickly as they can.
-

docs/faq.rst

@@ -190,7 +190,7 @@ Documentation
 
 **Q: I am seeing a lot of warnings when I build the docs.  How do I resolve them?**
 
-**A:** There is no need to build the docs locally unless you *really* want to.  The docs can be accessed without building them yourself by navigating to `<https://qiskit.org/documentation/metal/>`_.
+**A:** There is no need to build the docs locally unless you *really* want to.  The docs can be accessed without building them yourself by navigating to `<https://qiskit-community.github.io/qiskit-metal/>`_.
 
 If you chose to build the docs yourself, some users may see a list of warnings when building the docs.  Warnings about matplotlib text role can be safely ignored.
 

docs/tut/quick-topics/Opening-documentation.ipynb

@@ -19,7 +19,7 @@
    "metadata": {},
    "source": [
     "The documentation can be found here\n",
-    "https://qiskit.org/documentation/metal/"
+    "https://qiskit-community.github.io/qiskit-metal/"
    ]
   },
   {

qiskit_metal/__init__.py

@@ -37,7 +37,7 @@
             >>>>>> from the list of qiskit-metal package dependencies in Windows. <<<<<<\n \
             >>>>>>>> Before you can use Qiskit Metal, please install geopandas. <<<<<<<<\n \
             >>>> For more information, you can follow the instructions on this FAQ <<<<<\n \
-            >>>>>>>>>>>>> https://qiskit.org/documentation/metal/faq.html <<<<<<<<<<<<<<\n"
+            >>>>>>>>>>>>> https://qiskit-community.github.io/qiskit-metal/faq.html <<<<<<<<<<<<<<\n"
              )
         raise
 

qiskit_metal/_gui/main_window.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # This code is part of Qiskit.
 #
 # (C) Copyright IBM 2017, 2021.
@@ -221,7 +219,8 @@ def create_build_log_window(self, _=None):
     @slot_catch_error()
     def open_web_help(self, _=None):
         """"Handles click on Build History button."""
-        webbrowser.open('https://qiskit.org/documentation/metal/', new=1)
+        webbrowser.open('https://qiskit-community.github.io/qiskit-metal/',
+                        new=1)
 
     @slot_catch_error()
     def set_force_close(self, ison: bool):

qiskit_metal/toolbox_metal/about.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # This code is part of Qiskit.
 #
 # (C) Copyright IBM 2017, 2021.
@@ -108,7 +106,7 @@ def get_module_doc_page(module,
     return Path(os.path.dirname(module.__file__)) / folder / page
 
 
-def open_docs(page='https://qiskit.org/documentation/metal/'):
+def open_docs(page='https://qiskit-community.github.io/qiskit-metal/'):
     """Open the qiskit_metal documentation in HTML.
 
     Open the URL in new window, raising the window if possible.

setup.py

@@ -33,7 +33,7 @@
     long_description_content_type="text/markdown",
     url="https://github.com/Qiskit/qiskit-metal",
     author="Qiskit Metal Development Team",
-    author_email="qiskit@qiskit.org",
+    author_email="qiskit@us.ibm.com",
     license="Apache 2.0",
     classifiers=[
         "License :: OSI Approved :: Apache Software License",
@@ -54,7 +54,7 @@
     install_requires=requirements,
     project_urls={
         "Bug Tracker": "https://github.com/Qiskit/qiskit-metal/issues",
-        "Documentation": "https://qiskit.org/documentation/metal",
+        "Documentation": "https://qiskit-community.github.io/qiskit-metal/",
         "Source Code": "https://github.com/Qiskit/qiskit-metal",
     },
 )

tutorials/Appendix B Quick topics/Opening documentation.ipynb

@@ -19,7 +19,7 @@
    "metadata": {},
    "source": [
     "The documentation can be found here\n",
-    "https://qiskit.org/documentation/metal/"
+    "https://qiskit-community.github.io/qiskit-metal/"
    ]
   },
   {