Add docs build job

.github/workflows/build.yaml

@@ -52,6 +52,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"
   wheel-build-pylibraft:
     secrets: inherit
     uses: rapidsai/shared-action-workflows/.github/workflows/wheels-manylinux-build.yml@cuda-118

.github/workflows/pr.yaml

@@ -17,6 +17,7 @@ jobs:
       - conda-cpp-tests
       - conda-python-build
       - conda-python-tests
+      - docs-build
       - wheel-build-pylibraft
       - wheel-tests-pylibraft
       - wheel-build-raft-dask
@@ -51,6 +52,16 @@ 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"
   wheel-build-pylibraft:
     needs: checks
     secrets: inherit

ci/build_docs.sh

@@ -0,0 +1,51 @@
+#!/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-dependency-file-generator \
+  --output requirements \
+  --file_key docs \
+  --matrix "cuda=${RAPIDS_CUDA_VERSION%.*};arch=$(arch);py=${RAPIDS_PY_VERSION}" | tee requirements.txt
+
+rapids-mamba-retry env create --force -f env.yaml -n docs
+conda activate docs
+pip install -r requirements.txt
+
+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}" \
+  libraft-distance \
+  libraft-headers \
+  libraft-nn \
+  pylibraft \
+  raft-dask
+
+
+# Build CPP docs
+rapids-logger "Build CPP docs"
+#pushd docs
+#sphinx-build -b dirhtml source build -W
+#popd
+./build.sh docs -v -n
+
+
+if [[ ${RAPIDS_BUILD_TYPE} == "branch" ]]; then
+  rapids-logger "Upload Docs to S3"
+  aws s3 sync --delete docs/build "s3://rapidsai-docs/raft/${VERSION_NUMBER}/build"
+fi

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

@@ -24,6 +24,8 @@ dependencies:
 - doxygen>=1.8.20
 - faiss-proc=*=cuda
 - gcc_linux-64=9
+- graphviz
+- ipython
 - libcublas-dev=11.11.3.6
 - libcublas=11.11.3.6
 - libcurand-dev=10.3.0.86
@@ -34,12 +36,17 @@ dependencies:
 - libcusparse=11.7.5.86
 - libfaiss>=1.7.1=cuda*
 - ninja
+- numpydoc
+- pip
+- pydata-sphinx-theme
 - pytest
 - pytest-cov
+- recommonmark
 - rmm=23.04
 - scikit-build>=0.13.1
 - scikit-learn
 - scipy
+- sphinx-copybutton
 - sphinx-markdown-tables
 - sysroot_linux-64==2.17
 - ucx-proc=*=gpu

dependencies.yaml

@@ -9,7 +9,7 @@ files:
       - build
       - cudatoolkit
       - develop
-      - doc
+      - docs_build
       - run
       - test_python
   test_cpp:
@@ -27,6 +27,12 @@ files:
     includes:
       - checks
       - py_version
+  docs:
+    output: none
+    includes:
+      - cudatoolkit
+      - docs_build
+      - py_version
 channels:
   - rapidsai
   - rapidsai-nightly
@@ -131,18 +137,22 @@ dependencies:
               - *libcusolver114
               - *libcusparse_dev114
               - *libcusparse114
-  doc:
+  docs_build:
     common:
-      - output_types: [conda, requirements]
-        packages:
-          - breathe
-      - output_types: [requirements]
-        packages:
-          - sphinx_markdown_tables
       - output_types: [conda]
         packages:
+          - breathe
+          - cmake>=3.23.1,!=3.25.0
           - doxygen>=1.8.20
+          - graphviz
+          - ipython
+          - ninja
+          - numpydoc
+          - pydata-sphinx-theme
+          - sphinx-copybutton
           - sphinx-markdown-tables
+          - recommonmark
+          - pip
   py_version:
     specific:
       - output_types: conda