Deploy docs to GitHub Pages (#1303) (#1308)

* Deploy docs to GitHub Pages * Fix conf.py copyrighht date * gettext removed (cherry picked from commit cb55369) Co-authored-by: Arnau Casau <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
qiskit-community · Jan 25, 2024 · 402820b · 402820b
1 parent db73ef8
commit 402820b
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 173 deletions.
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -43,45 +43,20 @@ jobs:
           pip install -e .[pyscf,mpl,sparse]
           pip install -U -c constraints.txt -r requirements-dev.txt
         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('["mtreinish","woodsp-ibm","mrossinek","robertodr","matteoacrossi"]', github.actor) }}
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: [3.8]
-    steps:
-      - uses: actions/checkout@v3
+      - 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:
-          fetch-depth: 0
-      - uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install jupyter torchvision tox
-          sudo apt-get install -y pandoc
-        shell: bash
-      - 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
+          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 Nature Development Team"  # pylint: disable=redefined-builtin
 author = "Qiskit Nature Development Team"
 
-docs_url_prefix = "ecosystem/nature"
+docs_url_prefix = "qiskit-nature"
 
 # The short X.Y version
 version = qiskit_nature.__version__
@@ -159,8 +159,6 @@
     ("es_UN", "Spanish"),
 ]
 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
@@ -63,19 +63,3 @@ allowlist_externals =
 commands =
   rm -rf {toxinidir}/docs/stubs/ {toxinidir}/docs/_build
 
-[testenv:gettext]
-# Editable mode breaks macOS: https://github.com/sphinx-doc/sphinx/issues/10943
-usedevelop = False
-envdir = .tox/docs
-deps =
-  -r{toxinidir}/requirements.txt
-  -r{toxinidir}/requirements-dev.txt
-  pyscf; sys_platform != 'win32'
-  matplotlib>=3.3
-  sparse
-  opt_einsum
-  sphinx-intl
-  jupyter
-commands =
-  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