From 3a5a7cc8a01e51d1e351accb83af6f5a62b9d64e Mon Sep 17 00:00:00 2001 From: Luciano Bello Date: Sat, 15 Apr 2023 00:39:11 +0200 Subject: [PATCH] deploy documentation in qiskit.org/ecosystem (#1096) Similar to https://github.com/Qiskit/qiskit-aer/pull/1748, see https://github.com/Qiskit/qiskit.org/issues/3038 for more context ### Summary The Qiskit Ecosystem lives in qiskit.org/ecosystem and new place for qiskit related projects that are not technically Qiskit. This PR adds that destination for documentation deployment. ### Details and comments For now, a copy of the same docs in ecosystem would allow to have both q.o/documentation and q.o/ecosystem for testing that everything is fine. Once that's done, the CDN will redirects to the new location and the deploy to q.o/documentation can be removed. --------- Co-authored-by: Helena Zhang --- README.md | 2 +- setup.py | 2 +- tools/deploy_documentation.sh | 14 +++++++++----- tools/deploy_documentation_dev.sh | 1 + 4 files changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5e546b5855..bff6c2d9bc 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ 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/documentation/experiments/dev/) corresponding to the main branch of this repository or the [documentation for the latest stable release](https://qiskit.org/documentation/experiments). diff --git a/setup.py b/setup.py index ef9e8465d2..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/documentation/", + "Documentation": "https://qiskit.org/documentation/experiments", "Source Code": "https://github.com/Qiskit/qiskit-experiments", }, zip_safe=False, diff --git a/tools/deploy_documentation.sh b/tools/deploy_documentation.sh index 23fea2c370..92552689c7 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 @@ -31,9 +31,13 @@ IFS=. read -ra VERSION <<< "$CURRENT_TAG" STABLE_VERSION=${VERSION[0]}.${VERSION[1]} echo "Building for stable version $STABLE_VERSION" -# 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" +rclone sync --progress --exclude-from ./tools/other-builds.txt ./docs/_build/html IBMCOS:qiskit-org-web-resources/ecosystem/experiments +echo "Pushing $STABLE_VERSION built docs to website" +rclone sync --progress ./docs/_build/html IBMCOS:qiskit-org-web-resources/ecosystem/experiments/stable/"$STABLE_VERSION" + +# Push to qiskit.org/documentation rclone sync --progress --exclude-from ./tools/other-builds.txt ./docs/_build/html IBMCOS:qiskit-org-web-resources/documentation/experiments -echo "Pushing built docs to website" -rclone sync --progress ./docs/_build/html IBMCOS:qiskit-org-web-resources/documentation/experiments/stable/"$STABLE_VERSION" +rclone sync --progress ./docs/_build/html IBMCOS:qiskit-org-web-resources/documentation/experiments/stable/"$STABLE_VERSION" \ No newline at end of file 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