add docs builds to Github Actions

.github/workflows/build.yaml

@@ -34,6 +34,17 @@ jobs:
       branch: ${{ inputs.branch }}
       date: ${{ inputs.date }}
       sha: ${{ inputs.sha }}
+  docs-build:
+    if: ${{ startsWith(github.ref, 'refs/heads/branch-') }}
+    needs: [python-build]
+    secrets: inherit
+    uses: rapidsai/shared-action-workflows/.github/workflows/custom-job.yaml@cuda-118
+    with:
+      build_type: branch
+      node_type: "gpu-latest-1"
+      arch: "amd64"
+      container_image: "rapidsai/ci:latest"
+      run_script: "ci/build_docs.sh"
   python-build:
     needs: [cpp-build]
     secrets: inherit

.github/workflows/pr.yaml

@@ -16,6 +16,7 @@ jobs:
       - conda-cpp-build
       - conda-python-build
       - conda-python-tests
+      - docs-build
     secrets: inherit
     uses: rapidsai/shared-action-workflows/.github/workflows/pr-builder.yaml@cuda-118
   checks:
@@ -39,3 +40,13 @@ jobs:
     uses: rapidsai/shared-action-workflows/.github/workflows/conda-python-tests.yaml@cuda-118
     with:
       build_type: pull-request
+  docs-build:
+    needs: conda-python-build
+    secrets: inherit
+    uses: rapidsai/shared-action-workflows/.github/workflows/custom-job.yaml@cuda-118
+    with:
+      build_type: pull-request
+      node_type: "gpu-latest-1"
+      arch: "amd64"
+      container_image: "rapidsai/ci:latest"
+      run_script: "ci/build_docs.sh"

ci/build_docs.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+
+set -euo pipefail
+
+rapids-logger "Create test conda environment"
+. /opt/conda/etc/profile.d/conda.sh
+
+rapids-dependency-file-generator \
+    --output conda \
+    --file_key docs \
+    --matrix "cuda=${RAPIDS_CUDA_VERSION%.*};arch=$(arch);py=${RAPIDS_PY_VERSION}" | tee env.yaml
+
+rapids-mamba-retry env create --force -f env.yaml -n docs
+conda activate docs
+
+rapids-print-env
+
+rapids-logger "Downloading artifacts from previous jobs"
+CPP_CHANNEL=$(rapids-download-conda-from-s3 cpp)
+PYTHON_CHANNEL=$(rapids-download-conda-from-s3 python)
+VERSION_NUMBER=$(rapids-get-rapids-version-from-git)
+
+rapids-mamba-retry install \
+    --channel "${CPP_CHANNEL}" \
+    --channel "${PYTHON_CHANNEL}" \
+    cucim libcucim
+
+# Build Python docs
+rapids-logger "Build Python docs"
+pushd docs
+sphinx-build -b dirhtml ./source _html
+sphinx-build -b text ./source _text
+popd
+
+if [[ "${RAPIDS_BUILD_TYPE}" == "branch" ]]; then
+  rapids-logger "Upload Docs to S3"
+  aws s3 sync --no-progress --delete docs/_html "s3://rapidsai-docs/cucim/${VERSION_NUMBER}/html"
+  aws s3 sync --no-progress --delete docs/_text "s3://rapidsai-docs/cucim/${VERSION_NUMBER}/txt"
+fi

conda/environments/all_cuda-118_arch-x86_64.yaml

@@ -37,7 +37,7 @@ dependencies:
 - recommonmark
 - scikit-image >=0.19.0,<0.20.0a0
 - scipy
-- sphinx
+- sphinx<6
 - sysroot_linux-64==2.17
 - tifffile>=2022.7.28
 - xz

dependencies.yaml

@@ -9,7 +9,7 @@ files:
       - build
       - cudatoolkit
       - checks
-      - doc
+      - docs
       - py_version
       - run
       - test_python
@@ -24,6 +24,12 @@ files:
     includes:
       - checks
       - py_version
+  docs:
+    output: none
+    includes:
+      - cudatoolkit
+      - docs
+      - py_version
 channels:
   - rapidsai
   - rapidsai-nightly
@@ -91,7 +97,7 @@ dependencies:
               cuda: "11.8"
             packages:
               - cudatoolkit=11.8
-  doc:
+  docs:
     common:
       - output_types: [conda, requirements]
         packages:
@@ -100,7 +106,7 @@ dependencies:
           - numpydoc
           - pydata-sphinx-theme
           - recommonmark
-          - sphinx
+          - sphinx<6
   py_version:
     specific:
       - output_types: conda