From f6b05a72ad9c41a93e388f0c3a0684ae663e7e82 Mon Sep 17 00:00:00 2001 From: Luciano Bello Date: Tue, 21 Mar 2023 16:55:31 +0100 Subject: [PATCH 1/3] Update deploy_documentation.sh --- tools/deploy_documentation.sh | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/tools/deploy_documentation.sh b/tools/deploy_documentation.sh index 947cb54e7d..c70432bf2c 100755 --- a/tools/deploy_documentation.sh +++ b/tools/deploy_documentation.sh @@ -2,7 +2,7 @@ # This code is part of Qiskit. # -# (C) Copyright IBM 2018, 2019. +# (C) Copyright IBM 2018, 2023. # # This code is licensed under the Apache License, Version 2.0. You may # obtain a copy of this license in the LICENSE.txt file in the root directory @@ -12,7 +12,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -# Script for pushing the documentation to the qiskit.org repository. +# Script for pushing the documentation to the qiskit.org/ecosystem set -e curl https://downloads.rclone.org/rclone-current-linux-amd64.deb -o rclone.deb @@ -26,7 +26,10 @@ tox -edocs echo "show current dir: " pwd -# Push to qiskit.org website +# Push to qiskit.org/ecosystem openssl aes-256-cbc -K $encrypted_rclone_key -iv $encrypted_rclone_iv -in tools/rclone.conf.enc -out $RCLONE_CONFIG_PATH -d -echo "Pushing built docs to website" +echo "Pushing built docs to qiskit.org/ecosystem" +rclone sync --progress ./docs/_build/html IBMCOS:qiskit-org-web-resources/ecosystem/experiments + +# Push to qiskit.org/documentation rclone sync --progress ./docs/_build/html IBMCOS:qiskit-org-web-resources/documentation/experiments From c836b5a19ea17afd3ca33b5593164b7781588808 Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Wed, 22 Mar 2023 09:50:39 -0400 Subject: [PATCH 2/3] updated links to ecosystem --- CONTRIBUTING.md | 4 ++-- README.md | 4 ++-- docs/GUIDELINES.md | 8 ++++---- docs/index.rst | 2 +- setup.py | 2 +- tools/deploy_documentation_dev.sh | 1 + 6 files changed, 11 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 34381bc484..883f4b6ad9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -302,7 +302,7 @@ https://github.com/Qiskit/qiskit-experiments/blob/main/docs/release_notes.rst). ### Documentation -The [Qiskit Experiments documentation](https://qiskit.org/documentation/experiments/) is +The [Qiskit Experiments documentation](https://qiskit.org/ecosystem/experiments/) is rendered from `.rst` files as well as experiment and analysis class docstrings into HTML files. @@ -310,7 +310,7 @@ files. Any change that would affect existing documentation, or a new feature that requires a documentation, should be updated correspondingly. Before updating, review the [existing -documentation](https://qiskit.org/documentation/experiments) for their style and +documentation](https://qiskit.org/ecosystem/experiments) for their style and content, and read the [documentation guidelines](docs/GUIDELINES.md) for further details. diff --git a/README.md b/README.md index a30894f41b..3e4801a836 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ and analyzing experiments on noisy quantum computers using Qiskit. To learn more about the package, you can see the -[most up-to-date documentation](https://qiskit.org/documentation/experiments/dev/) +[most up-to-date documentation](https://qiskit.org/ecosystem/experiments/dev/) corresponding to the main branch of this repository or the -[documentation for the latest stable release](https://qiskit.org/documentation/experiments). +[documentation for the latest stable release](https://qiskit.org/ecosystem/experiments). ## Contribution Guidelines diff --git a/docs/GUIDELINES.md b/docs/GUIDELINES.md index 32fa658947..eb3ca88b81 100644 --- a/docs/GUIDELINES.md +++ b/docs/GUIDELINES.md @@ -162,8 +162,8 @@ example and example outputs by printing relevant analysis results and plot figur Required and common parameters, such as experiment and analysis options, should be covered. -See the [Randomized Benchmarking](https://qiskit.org/documentation/experiments/manuals/benchmarking/randomized_benchmarking.html) -guide and its [source code](docs/manuals/benchmarking/randomized_benchmarking.rst) for an +See the [Randomized Benchmarking](docs/manuals/verification/randomized_benchmarking.rst) +manual for an example. Here is a simple template for a manual: ``` @@ -380,9 +380,9 @@ header should be named `Analysis Options` to be parsed correctly. After you complete documentation of your classes, you must add documentation to the toctree so that it can be rendered as the API documentation. In Qiskit Experiments, we have a separate tables of contents for each experiment module (e.g. [characterization -experiments](https://qiskit.org/documentation/experiments/apidocs/mod_characterization.html)) +experiments](https://qiskit.org/ecosystem/experiments/apidocs/mod_characterization.html)) and for the [entire -library](https://qiskit.org/documentation/experiments/apidocs/library.html). Thus we +library](https://qiskit.org/ecosystem/experiments/apidocs/library.html). Thus we should add document to the tree of a particular module and then reference it to the entire module. diff --git a/docs/index.rst b/docs/index.rst index d324676fea..b3d0ac8a9d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -120,7 +120,7 @@ We've divided up the documentation into four sections with different purposes: apidocs/index release_notes GitHub - Development Branch Docs + Development Branch Docs | diff --git a/setup.py b/setup.py index ef9e8465d2..29d2effd45 100755 --- a/setup.py +++ b/setup.py @@ -64,7 +64,7 @@ python_requires=">=3.7", project_urls={ "Bug Tracker": "https://github.com/Qiskit/qiskit-experiments/issues", - "Documentation": "https://qiskit.org/documentation/", + "Documentation": "https://qiskit.org/ecosystem/experiments", "Source Code": "https://github.com/Qiskit/qiskit-experiments", }, zip_safe=False, diff --git a/tools/deploy_documentation_dev.sh b/tools/deploy_documentation_dev.sh index 529c1bd084..fba5003f0b 100755 --- a/tools/deploy_documentation_dev.sh +++ b/tools/deploy_documentation_dev.sh @@ -29,4 +29,5 @@ pwd # Push to qiskit.org website openssl aes-256-cbc -K $encrypted_rclone_key -iv $encrypted_rclone_iv -in tools/rclone.conf.enc -out $RCLONE_CONFIG_PATH -d echo "Pushing built docs to dev website" +rclone sync --progress ./docs/_build/html IBMCOS:qiskit-org-web-resources/documentation/ecosystem/dev rclone sync --progress ./docs/_build/html IBMCOS:qiskit-org-web-resources/documentation/experiments/dev From 0ebfd1d3bf113867bec9148a9b67592e32a6c460 Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Tue, 28 Mar 2023 08:32:23 -0400 Subject: [PATCH 3/3] revert link changes --- CONTRIBUTING.md | 4 ++-- README.md | 4 ++-- docs/GUIDELINES.md | 8 ++++---- docs/index.rst | 2 +- setup.py | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 883f4b6ad9..34381bc484 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -302,7 +302,7 @@ https://github.com/Qiskit/qiskit-experiments/blob/main/docs/release_notes.rst). ### Documentation -The [Qiskit Experiments documentation](https://qiskit.org/ecosystem/experiments/) is +The [Qiskit Experiments documentation](https://qiskit.org/documentation/experiments/) is rendered from `.rst` files as well as experiment and analysis class docstrings into HTML files. @@ -310,7 +310,7 @@ files. Any change that would affect existing documentation, or a new feature that requires a documentation, should be updated correspondingly. Before updating, review the [existing -documentation](https://qiskit.org/ecosystem/experiments) for their style and +documentation](https://qiskit.org/documentation/experiments) for their style and content, and read the [documentation guidelines](docs/GUIDELINES.md) for further details. diff --git a/README.md b/README.md index 3e4801a836..06ae9f0109 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ and analyzing experiments on noisy quantum computers using Qiskit. To learn more about the package, you can see the -[most up-to-date documentation](https://qiskit.org/ecosystem/experiments/dev/) +[most up-to-date documentation](https://qiskit.org/documentation/experiments/dev/) corresponding to the main branch of this repository or the -[documentation for the latest stable release](https://qiskit.org/ecosystem/experiments). +[documentation for the latest stable release](https://qiskit.org/documentation/experiments). ## Contribution Guidelines diff --git a/docs/GUIDELINES.md b/docs/GUIDELINES.md index eb3ca88b81..32fa658947 100644 --- a/docs/GUIDELINES.md +++ b/docs/GUIDELINES.md @@ -162,8 +162,8 @@ example and example outputs by printing relevant analysis results and plot figur Required and common parameters, such as experiment and analysis options, should be covered. -See the [Randomized Benchmarking](docs/manuals/verification/randomized_benchmarking.rst) -manual for an +See the [Randomized Benchmarking](https://qiskit.org/documentation/experiments/manuals/benchmarking/randomized_benchmarking.html) +guide and its [source code](docs/manuals/benchmarking/randomized_benchmarking.rst) for an example. Here is a simple template for a manual: ``` @@ -380,9 +380,9 @@ header should be named `Analysis Options` to be parsed correctly. After you complete documentation of your classes, you must add documentation to the toctree so that it can be rendered as the API documentation. In Qiskit Experiments, we have a separate tables of contents for each experiment module (e.g. [characterization -experiments](https://qiskit.org/ecosystem/experiments/apidocs/mod_characterization.html)) +experiments](https://qiskit.org/documentation/experiments/apidocs/mod_characterization.html)) and for the [entire -library](https://qiskit.org/ecosystem/experiments/apidocs/library.html). Thus we +library](https://qiskit.org/documentation/experiments/apidocs/library.html). Thus we should add document to the tree of a particular module and then reference it to the entire module. diff --git a/docs/index.rst b/docs/index.rst index b3d0ac8a9d..d324676fea 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -120,7 +120,7 @@ We've divided up the documentation into four sections with different purposes: apidocs/index release_notes GitHub - Development Branch Docs + Development Branch Docs | diff --git a/setup.py b/setup.py index 29d2effd45..f08a7b3688 100755 --- a/setup.py +++ b/setup.py @@ -64,7 +64,7 @@ python_requires=">=3.7", project_urls={ "Bug Tracker": "https://github.com/Qiskit/qiskit-experiments/issues", - "Documentation": "https://qiskit.org/ecosystem/experiments", + "Documentation": "https://qiskit.org/documentation/experiments", "Source Code": "https://github.com/Qiskit/qiskit-experiments", }, zip_safe=False,