From 5fd9379e22dacdf4b7bf7d67eb327b969c31ed13 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Tue, 26 Dec 2023 19:59:52 +0100 Subject: [PATCH 1/2] Deploy docs to GitHub Pages --- .github/workflows/docs.yml | 14 +++++++------ tools/deploy_documentation.sh | 36 ---------------------------------- tools/rclone.conf.enc | Bin 304 -> 0 bytes 3 files changed, 8 insertions(+), 42 deletions(-) delete mode 100755 tools/deploy_documentation.sh delete mode 100644 tools/rclone.conf.enc diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 4f3ddf318..e2e430fdb 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -21,9 +21,11 @@ jobs: pip install -U tox==4.11.0 setuptools==67.3.1 virtualenv==20.24.3 wheel==0.38.4 sudo apt update sudo apt install graphviz=2.42.2-6 pandoc=2.9.2.1-3ubuntu2 qtbase5-dev=5.15.3+dfsg-2ubuntu0.2 qt5-qmake=5.15.3+dfsg-2ubuntu0.2 - - name: Build and publish - env: - encrypted_rclone_key: ${{ secrets.encrypted_rclone_key }} - encrypted_rclone_iv: ${{ secrets.encrypted_rclone_iv }} - run: | - tools/deploy_documentation.sh + - name: Build docs + run: tox -edocs + - name: Bypass Jekyll Processing # Necessary for setting the correct css path + run: touch docs/_build/html/.nojekyll + - name: Deploy + uses: JamesIves/github-pages-deploy-action@v4 + with: + folder: docs/_build/html/ diff --git a/tools/deploy_documentation.sh b/tools/deploy_documentation.sh deleted file mode 100755 index 7b218a83b..000000000 --- a/tools/deploy_documentation.sh +++ /dev/null @@ -1,36 +0,0 @@ - -#!/bin/bash - -# This code is part of Qiskit. -# -# (C) Copyright IBM 2017, 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 -# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0. -# -# Any modifications or derivative works of this code must retain this -# 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/ecosystem. -set -e - -curl https://downloads.rclone.org/rclone-current-linux-amd64.deb -o rclone.deb -sudo apt-get install -y ./rclone.deb - -RCLONE_CONFIG_PATH=$(rclone config file | tail -1) - -# Build the documentation. -tox -edocs -- -j auto - -echo "show current dir: " -pwd - -# 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 qiskit.org/ecosystem" -rclone sync --progress ./docs/_build/html IBMCOS:qiskit-org-web-resources/ecosystem/metal - -# Push to qiskit.org/documentation -rclone sync --progress ./docs/_build/html IBMCOS:qiskit-org-web-resources/documentation/metal diff --git a/tools/rclone.conf.enc b/tools/rclone.conf.enc deleted file mode 100644 index 985bd728abc0a83d8ea98cd4d9561b7fa124842f..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 304 zcmV-00nh$7&RTYTNLa46ND6UrOuMoPNp}L^N21;+KWICI2ddxLf?x*g*GAzexAhvW z5rTO-?xi4$c>vaY~!DfD~lI0H5)o5;H>qj7M~)ZT{14Fvc91%J)Ycl~B`S zR;dTAK}Qz7!C#ExhwZKgVKh_&DPch2pvl7`Df`TB7^fDm2w+?}@Ltb_s9A^-JfyD- zcV@+wP8bfhSO=k!OfNS+tVO*B2xkEIky>2YRz;z0Ar#-=dP|4$ar~If5$=F}D=bc3 C!HCcR From 5f44226068dc9490ad5361b3790e9cd7c0127420 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Tue, 26 Dec 2023 20:06:04 +0100 Subject: [PATCH 2/2] update tox -edocs --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e2e430fdb..2d46972b5 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -22,7 +22,7 @@ jobs: sudo apt update sudo apt install graphviz=2.42.2-6 pandoc=2.9.2.1-3ubuntu2 qtbase5-dev=5.15.3+dfsg-2ubuntu0.2 qt5-qmake=5.15.3+dfsg-2ubuntu0.2 - name: Build docs - run: tox -edocs + run: tox -edocs -- -j auto - name: Bypass Jekyll Processing # Necessary for setting the correct css path run: touch docs/_build/html/.nojekyll - name: Deploy