Deploy docs to GitHub Pages (backport #739) (#744)

* Deploy docs to GitHub Pages (#739) * Deploy docs to GitHub Pages * Fix conf.py copyrighht date * gettext removed (cherry picked from commit 7e860cc) # Conflicts: # .github/workflows/deploy-docs.yml * Update deploy-docs.yml Fix it so it matches what is in main. --------- Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com> Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>
qiskit-community · Jan 24, 2024 · ef0bad4 · ef0bad4
1 parent 0ef6dfe
commit ef0bad4
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 172 deletions.
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -21,7 +21,7 @@ concurrency:
 
 jobs:
   docs_publish:
-    if: ${{ startsWith(github.ref, 'refs/heads/stable') && contains('["adekusar-drl","mtreinish","stefan-woerner","woodsp-ibm"]', github.actor) }}
+    if: ${{ startsWith(github.ref, 'refs/heads/stable') && contains('[adekusar-drl","mtreinish","woodsp-ibm","smens","edoaltamura","oscar-wallis","OkuyanBoga","Benjamin-Symons"]', github.actor) }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -39,45 +39,20 @@ jobs:
           pip install jupyter qiskit[visualization] 'torchvision<0.10.0'
           sudo apt-get install -y pandoc graphviz
         shell: bash
-      - name: Build and publish
+      - name: Build docs
         env:
-          encrypted_rclone_key: ${{ secrets.encrypted_rclone_key }}
-          encrypted_rclone_iv: ${{ secrets.encrypted_rclone_iv }}
           QISKIT_PARALLEL: False
           QISKIT_DOCS_BUILD_TUTORIALS: 'always'
         run: |
           echo "earliest_version: 0.1.0" >> releasenotes/config.yaml
           tools/ignore_untagged_notes.sh
           make html
-          tools/deploy_documentation.sh
         shell: bash
-  deploy-translatable-strings:
-    if: ${{ startsWith(github.ref, 'refs/heads/stable') && contains('["adekusar-drl","mtreinish","stefan-woerner","woodsp-ibm"]', github.actor) }}
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: [3.8]
-    steps:
-    - uses: actions/checkout@v3
-      with:
-        fetch-depth: 0
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install jupyter qiskit[visualization] 'torchvision<0.10.0' tox
-        sudo apt-get install -y graphviz pandoc
-    - name: Build and publish
-      env:
-        encrypted_deploy_po_branch_key: ${{ secrets.encrypted_deploy_po_branch_key }}
-        encrypted_deploy_po_branch_iv: ${{ secrets.encrypted_deploy_po_branch_iv }}
-        QISKIT_PARALLEL: False
-        QISKIT_DOCS_BUILD_TUTORIALS: 'always'
-      run: |
-        echo "earliest_version: 0.1.0" >> releasenotes/config.yaml
-        tools/ignore_untagged_notes.sh
-        tools/deploy_translatable_strings.sh
-      shell: bash
+      - 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/
+          clean-exclude: |
+            locale/*
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,6 +1,6 @@
 # This code is part of a Qiskit project.
 #
-# (C) Copyright IBM 2021, 2023.
+# (C) Copyright IBM 2021, 2024.
 #
 # 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
@@ -42,7 +42,7 @@
 copyright = f"2018, {date.today().year}, Qiskit Machine Learning Development Team"  # pylint: disable=redefined-builtin
 author = "Qiskit Machine Learning Development Team"
 
-docs_url_prefix = "ecosystem/machine-learning"
+docs_url_prefix = "qiskit-machine-learning"
 
 # The short X.Y version
 version = qiskit_machine_learning.__version__
@@ -149,8 +149,6 @@
     ("tr_TR", "Turkish"),
 ]
 language = "en"
-locale_dirs = ["locale/"]
-gettext_compact = False  # optional.
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

diff --git a/tools/deploy_documentation.sh b/tools/deploy_documentation.sh
diff --git a/tools/deploy_translatable_strings.sh b/tools/deploy_translatable_strings.sh
diff --git a/tools/github_poBranch_update_key.enc b/tools/github_poBranch_update_key.enc
diff --git a/tools/rclone.conf.enc b/tools/rclone.conf.enc
diff --git a/tox.ini b/tox.ini
@@ -85,17 +85,3 @@ deps =
 allowlist_externals = rm
 commands = rm -rf {toxinidir}/docs/stubs/ {toxinidir}/docs/_build
 
-[testenv:gettext]
-envdir = .tox/docs
-deps =
-  -r{toxinidir}/requirements.txt
-  -r{toxinidir}/requirements-dev.txt
-  torch
-  sparse
-  torchvision
-  sphinx-intl
-  jupyter
-commands =
-  pip install -e .
-  sphinx-build -W -T --keep-going -b gettext docs/ docs/_build/gettext {posargs}
-  sphinx-intl -c docs/conf.py update -p docs/_build/gettext -l en -d docs/locale