MAINT: Deploy docs on each merge

.ci/azure-pipelines.yml

@@ -236,81 +236,3 @@ stages:
       - script: |
           bash <(curl -s https://codecov.io/bash)
         displayName: 'Upload coverage to codecov.io'
-
-
-  # Builds the documentation
-  - job: BuildDocumentation
-    pool:
-      vmImage: 'ubuntu-latest'
-
-    variables:
-      DISPLAY: ':99.0'
-      PYVISTA_OFF_SCREEN: 'True'
-
-    steps:
-    - task: UsePythonVersion@0
-      inputs:
-        versionSpec: '3.10'
-      displayName: 'Use Python 3.10'
-
-    - script: |
-        git config --global user.name ${GH_NAME}
-        git config --global user.email ${GH_EMAIL}
-        git config --list | grep user.
-      displayName: 'Configure git'
-      env:
-        GH_NAME: $(gh.name)
-        GH_EMAIL: $(gh.email)
-
-    - script: |
-        sudo apt-get install python3-tk
-        # The following linux deps are necessary to use the builtin xcb:
-        # https://github.com/pyvista/pyvistaqt/pull/61#issuecomment-709320826
-        sudo apt-get install -y libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0    \
-                                libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 \
-                                libxcb-xinerama0 libxcb-xfixes0 libxcb-shape0
-        pip install -r requirements_docs.txt
-      displayName: 'Install dependencies'
-
-    - script: |
-        pip install PyQt5>=5.11
-        pip install -e .
-      displayName: Install pyvistaqt
-
-    - script: |
-        .ci/setup_headless_display.sh
-        # python .ci/pyvista_test.py  # for debug
-      displayName: Install headless display
-
-    - script: |
-        make -C docs html -b coverage
-        cat docs/_build/coverage/python.txt
-      displayName: 'Build documentation'
-
-    - script: |
-        make -C docs doctest
-      displayName: 'Test documentation code snippets'
-
-    - script: |
-        make -C docs html
-      displayName: 'Update figures from doctest'
-
-    # upload documentation to pyvistaqt-docs
-    - script: |
-        git clone --depth 1 https://${GH_TOKEN}@github.com/pyvista/pyvistaqt-docs.git
-        cd pyvistaqt-docs
-        git gc --prune=now
-        git remote prune origin
-        rm -rf *
-        cp -r $BUILD_SOURCESDIRECTORY/docs/_build/html/* .
-        cp $BUILD_SOURCESDIRECTORY/docs/README.md .
-        touch .nojekyll
-        echo "qtdocs.pyvista.org" >> CNAME
-        echo $(date) > BUILD_DATETIME
-        git add .
-        git commit -am "Azure CI commit ref $(Build.SourceVersion)"
-        git push
-      displayName: Upload Documentation to pyvistaqt-docs
-      env:
-        GH_TOKEN: $(gh.token)
-      condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))

.github/workflows/ci.yml

@@ -93,13 +93,13 @@ jobs:
         shell: bash -e {0}
     env:
       ALLOW_PLOTTING: 'true'
-      DISPLAY: ':99'
       PYTHON_VERSION: '3.9'
     steps:
       - uses: actions/checkout@v3
-      - run: .ci/setup_headless_display.sh
-        name: 'Setup xvfb'
-        if: matrix.os == 'ubuntu-latest'
+      - uses: pyvista/setup-headless-display-action@main
+        with:
+          qt: true
+          pyvista: false
       - run: |
           git clone --depth 1 https://github.com/pyvista/gl-ci-helpers.git
           ./gl-ci-helpers/appveyor/install_opengl.ps1
@@ -145,14 +145,14 @@ jobs:
         shell: bash
     env:
       ALLOW_PLOTTING: 'true'
-      DISPLAY: ':99'
       CONDA_ENV: 'environment.yml'
       PYTHON_VERSION: '3.8'
     steps:
       - uses: actions/checkout@v3
-      - run: .ci/setup_headless_display.sh
-        name: 'Setup xvfb'
-        if: matrix.os == 'ubuntu-latest'
+      - uses: pyvista/setup-headless-display-action@main
+        with:
+          qt: true
+          pyvista: false
       - run: |
           git clone --depth 1 https://github.com/pyvista/gl-ci-helpers.git
           ./gl-ci-helpers/appveyor/install_opengl.ps1

.github/workflows/docbuild.yml

@@ -0,0 +1,41 @@
+name: Documentation
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+    tags:
+      - "*"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+          cache-dependency-path: |
+            **/requirements_docs.txt
+      - uses: pyvista/setup-headless-display-action@main
+        with:
+          qt: true
+      - run: pip install . -r requirements_docs.txt "PySide6!=6.5.1"
+      - run: make -C docs doctest html
+      - uses: peaceiris/actions-gh-pages@v3
+        # Not a PR:
+        if: startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/heads')
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          external_repository: pyvista/pyvistaqt-docs
+          publish_branch: master
+          publish_dir: ./docs/_build/html
+          cname: qtdocs.pyvista.org