Add docs build job

.github/workflows/build.yaml

@@ -52,3 +52,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

@@ -18,6 +18,7 @@ jobs:
       - conda-notebook-tests
       - conda-python-build
       - conda-python-tests
+      - docs-build
     secrets: inherit
     uses: rapidsai/shared-action-workflows/.github/workflows/pr-builder.yaml@main
   checks:
@@ -58,3 +59,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,59 @@
+#!/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 test
+conda activate test
+
+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}" \
+  libcugraph \
+  pylibcugraph \
+  cugraph \
+  cugraph-pyg \
+  cugraph-service-server \
+  cugraph-service-client \
+  libcugraph_etl
+
+# This command installs `cugraph-dgl` without its dependencies
+# since this package can currently only run in `11.6` CTK environments
+# due to the dependency version specifications in its conda recipe.
+rapids-mamba-retry install "${PYTHON_CHANNEL}/linux-64/cugraph-dgl-*.tar.bz2"
+
+
+# Build Doxygen docs
+rapids-logger "Build Doxygen docs"
+pushd cpp/doxygen
+doxygen Doxyfile
+popd
+
+# Build Python docs
+rapids-logger "Build Sphinx docs"
+pushd docs/cugraph
+sphinx-build -b dirhtml source _html
+sphinx-build -b text source _text
+popd
+
+
+if [[ ${RAPIDS_BUILD_TYPE} == "branch" ]]; then
+  aws s3 sync --delete docs/cugraph/_html "s3://rapidsai-docs/cugraph/${VERSION_NUMBER}/html"
+  aws s3 sync --delete docs/cugraph/_text "s3://rapidsai-docs/cugraph/${VERSION_NUMBER}/txt"
+  aws s3 sync --delete cpp/doxygen/html "s3://rapidsai-docs/libcugraph/${VERSION_NUMBER}/html"
+fi

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

@@ -19,7 +19,6 @@ dependencies:
 - dask-cudf=23.02.*
 - dask>=2022.12.0
 - distributed>=2022.12.0
-- doxygen
 - gmock=1.10.0
 - gtest=1.10.0
 - ipython
@@ -28,35 +27,27 @@ dependencies:
 - libraft-distance=23.02.*
 - libraft-headers=23.02.*
 - librmm=23.02.*
-- nbsphinx
 - nccl>=2.9.9
 - networkx>=2.5.1
 - ninja
 - notebook>=0.5.0
-- numpydoc
 - nvcc_linux-64=11.5
 - ogb
 - openmpi
 - pip
 - pre-commit
 - py
-- pydata-sphinx-theme
 - pylibraft=23.02.*
 - pytest
 - pytest-cov
 - python-louvain
 - raft-dask=23.02.*
 - rapids-pytest-benchmark
-- recommonmark
 - requests
 - rmm=23.02.*
 - scikit-build>=0.13.1
 - scikit-learn>=0.23.1
 - scipy
-- sphinx
-- sphinx-copybutton
-- sphinx-markdown-tables
-- sphinxcontrib-websupport
 - ucx-proc=*=gpu
 - ucx-py=0.30.*
 name: all_cuda-115_arch-x86_64

dependencies.yaml

@@ -11,7 +11,6 @@ files:
       - common_python_test
       - cpp_build
       - cudatoolkit
-      - doc
       - python_build
       - test_notebook
       - test_python
@@ -20,6 +19,12 @@ files:
     includes:
       - checks
       - py_version
+  docs:
+    output: none
+    includes:
+      - cudatoolkit
+      - py_version
+      - docs_build
   test_cpp:
     output: none
     includes:
@@ -133,7 +138,7 @@ dependencies:
           - scikit-build>=0.13.1
           - ucx-proc=*=gpu
           - ucx-py=0.30.*
-  doc:
+  docs_build:
     common:
       - output_types: [conda]
         packages:
@@ -142,7 +147,9 @@ dependencies:
           - numpydoc
           - pydata-sphinx-theme
           - recommonmark
-          - sphinx
+          - sphinx<6
+          - sphinx_rtd_theme
+          - ipython
           - sphinxcontrib-websupport
           - sphinx-markdown-tables
           - sphinx-copybutton