Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

deploy documentation in qiskit.org/ecosystem #1096

Merged
merged 4 commits into from
Apr 14, 2023
Merged

deploy documentation in qiskit.org/ecosystem #1096

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f6b05a7
Update deploy_documentation.sh
1ucian0 Mar 21, 2023
690c48c
Merge branch 'main' into docs_to_ecosystem
1ucian0 Mar 22, 2023
c836b5a
updated links to ecosystem
coruscating Mar 22, 2023
0ebfd1d
revert link changes
coruscating Mar 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,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
View file
Open in desktop
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
View file
Open in desktop
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]}

# 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
View file
Open in desktop
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