Skip to content

Commit

Permalink
deploy documentation in qiskit.org/ecosystem (#1096)
Browse files Browse the repository at this point in the history
Similar to Qiskit/qiskit-aer#1748, see
Qiskit/qiskit.org#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 <helena.zhang@ibm.com>
  • Loading branch information
1ucian0 and coruscating authored Apr 14, 2023
1 parent d3df73a commit 3a5a7cc
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
14 changes: 9 additions & 5 deletions tools/deploy_documentation.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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"
1 change: 1 addition & 0 deletions tools/deploy_documentation_dev.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 3a5a7cc

Please sign in to comment.