Add docs build job

.github/workflows/build.yaml

@@ -43,3 +43,14 @@ 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"

.github/workflows/pr.yaml

@@ -16,6 +16,7 @@ jobs:
       - conda-python-build
       - conda-python-tests
       - conda-notebook-tests
+      - docs-build
     secrets: inherit
     uses: rapidsai/shared-action-workflows/.github/workflows/pr-builder.yaml@cuda-118
   checks:
@@ -43,3 +44,13 @@ jobs:
       arch: "amd64"
       container_image: "rapidsai/ci:latest"
       run_script: "ci/test_notebooks.sh"
+  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,37 @@
+#!/bin/bash
+# Copyright (c) 2023, NVIDIA CORPORATION.
+
+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"
+PYTHON_CHANNEL=$(rapids-download-conda-from-s3 python)
+VERSION_NUMBER=$(rapids-get-rapids-version-from-git)
+
+rapids-mamba-retry install \
+  --channel "${PYTHON_CHANNEL}" \
+  cusignal
+
+rapids-logger "Build Sphinx docs"
+pushd docs
+sphinx-build -b dirhtml source _html
+sphinx-build -b text source _text
+popd
+
+
+if [[ ${RAPIDS_BUILD_TYPE} == "branch" ]]; then
+  aws s3 sync --delete docs/_html "s3://rapidsai-docs/cusignal/${VERSION_NUMBER}/html"
+  aws s3 sync --delete docs/_text "s3://rapidsai-docs/cusignal/${VERSION_NUMBER}/txt"
+fi

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

@@ -13,12 +13,16 @@ dependencies:
 - notebook
 - numba >=0.49.0
 - numpy >=1.19,<1.24
+- numpydoc
 - pre-commit
+- pydata-sphinx-theme
 - pytest
 - pytest-benchmark
 - pytest-cov
 - pytest-xdist
 - python>=3.8,<3.11
 - pytorch <=1.12.1
 - scipy >=1.6.0
+- sphinx-copybutton
+- sphinx<6
 name: all_cuda-118_arch-x86_64

dependencies.yaml

@@ -8,6 +8,7 @@ files:
     includes:
       - checks
       - cudatoolkit
+      - docs_build
       - py_version
       - run
       - test_notebooks
@@ -29,6 +30,12 @@ files:
     includes:
       - checks
       - py_version
+  docs:
+    output: none
+    includes:
+      - cudatoolkit
+      - docs_build
+      - py_version
 channels:
   - rapidsai
   - rapidsai-nightly
@@ -60,6 +67,15 @@ dependencies:
       - output_types: [conda, requirements]
         packages:
           - pre-commit
+  docs_build:
+    common:
+      - output_types: [conda, requirements]
+        packages:
+          - ipython
+          - numpydoc
+          - pydata-sphinx-theme
+          - sphinx<6
+          - sphinx-copybutton
   py_version:
     specific:
       - output_types: conda