build libwholegraph docs in CI (#96)

Fixes #94

Uploads API docs for `libwholegraph`, to be used by rapidsai/cugraph-docs#46

Also removes `sphinx` dependencies... this repo only needs to produce Doxygen docs for `libwholegraph`, all the other Sphinx stuff will be done in https://github.com/rapidsai/cugraph-docs.

Authors:
  - James Lamb (https://github.com/jameslamb)
  - Don Acosta (https://github.com/acostadon)

Approvers:
  - Don Acosta (https://github.com/acostadon)
  - Bradley Dice (https://github.com/bdice)

URL: #96

.github/workflows/build.yaml

@@ -43,6 +43,18 @@ jobs:
       branch: ${{ inputs.branch }}
       date: ${{ inputs.date }}
       sha: ${{ inputs.sha }}
+  docs-build:
+    needs: conda-cpp-build
+    secrets: inherit
+    uses: rapidsai/shared-workflows/.github/workflows/[email protected]
+    with:
+      arch: "amd64"
+      branch: ${{ inputs.branch }}
+      build_type: ${{ inputs.build_type || 'branch' }}
+      container_image: "rapidsai/ci-conda:latest"
+      date: ${{ inputs.date }}
+      run_script: "ci/build_docs.sh"
+      sha: ${{ inputs.sha }}
   upload-conda:
     needs: [cpp-build, python-build]
     secrets: inherit

.github/workflows/pr.yaml

@@ -19,6 +19,7 @@ jobs:
       - conda-cpp-tests
       - conda-python-build
       - conda-python-tests
+      - docs-build
       - conda-notebook-tests
       - wheel-build-pylibwholegraph
       - wheel-tests-pylibwholegraph
@@ -116,6 +117,15 @@ jobs:
     with:
       build_type: pull-request
       matrix_filter: map(select(.ARCH == "amd64"))
+  docs-build:
+    needs: conda-cpp-build
+    secrets: inherit
+    uses: rapidsai/shared-workflows/.github/workflows/[email protected]
+    with:
+      arch: "amd64"
+      build_type: pull-request
+      container_image: "rapidsai/ci-conda:latest"
+      run_script: "ci/build_docs.sh"
   wheel-build-pylibwholegraph:
     needs: checks
     secrets: inherit

ci/build_docs.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+# Copyright (c) 2023-2024, NVIDIA CORPORATION.
+
+set -euo pipefail
+
+rapids-logger "Create test conda environment"
+. /opt/conda/etc/profile.d/conda.sh
+
+RAPIDS_VERSION="$(rapids-version)"
+
+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 --yes -f env.yaml -n docs
+
+# Temporarily allow unbound variables for conda activation.
+set +u
+conda activate docs
+set -u
+
+rapids-print-env
+
+rapids-logger "Downloading artifacts from previous jobs"
+
+CPP_CHANNEL=$(rapids-download-conda-from-s3 cpp)
+export RAPIDS_DOCS_DIR="$(mktemp -d)"
+
+rapids-mamba-retry install \
+  --channel "${CPP_CHANNEL}" \
+  "libwholegraph=${RAPIDS_VERSION}"
+
+rapids-logger "Build C++ docs"
+pushd cpp
+doxygen Doxyfile
+mkdir -p "${RAPIDS_DOCS_DIR}/libwholegraph/xml_tar"
+tar -czf "${RAPIDS_DOCS_DIR}/libwholegraph/xml_tar"/xml.tar.gz -C xml .
+popd
+
+rapids-logger "Output temp dir: ${RAPIDS_DOCS_DIR}"
+
+RAPIDS_VERSION_NUMBER="$(rapids-version-major-minor)" rapids-upload-docs

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

@@ -23,19 +23,16 @@ dependencies:
 - graphviz
 - ipython
 - nbconvert
-- nbsphinx
 - nccl>=2.19
 - ninja
 - notebook>=0.5.0
 - numba>=0.57
 - numpy>=1.23,<3.0a0
-- numpydoc
 - nvcc_linux-64=11.8
 - ogb
 - pandas
 - pre-commit
 - pydantic
-- pydata-sphinx-theme
 - pylibcugraphops==25.2.*,>=0.0.0a0
 - pylibraft==25.2.*,>=0.0.0a0
 - pytest
@@ -48,15 +45,10 @@ dependencies:
 - pytorch_geometric>=2.5,<2.6
 - raft-dask==25.2.*,>=0.0.0a0
 - rapids-build-backend>=0.3.0,<0.4.0.dev0
-- recommonmark
 - rmm==25.2.*,>=0.0.0a0
 - scikit-build-core>=0.10.0
 - scipy
 - setuptools>=61.0.0
-- sphinx-copybutton
-- sphinx-markdown-tables
-- sphinx<6
-- sphinxcontrib-websupport
 - torchdata
 - wheel
 name: all_cuda-118_arch-x86_64

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

@@ -30,18 +30,15 @@ dependencies:
 - libcusolver-dev
 - libcusparse-dev
 - nbconvert
-- nbsphinx
 - nccl>=2.19
 - ninja
 - notebook>=0.5.0
 - numba>=0.57
 - numpy>=1.23,<3.0a0
-- numpydoc
 - ogb
 - pandas
 - pre-commit
 - pydantic
-- pydata-sphinx-theme
 - pylibcugraphops==25.2.*,>=0.0.0a0
 - pylibraft==25.2.*,>=0.0.0a0
 - pytest
@@ -54,15 +51,10 @@ dependencies:
 - pytorch_geometric>=2.5,<2.6
 - raft-dask==25.2.*,>=0.0.0a0
 - rapids-build-backend>=0.3.0,<0.4.0.dev0
-- recommonmark
 - rmm==25.2.*,>=0.0.0a0
 - scikit-build-core>=0.10.0
 - scipy
 - setuptools>=61.0.0
-- sphinx-copybutton
-- sphinx-markdown-tables
-- sphinx<6
-- sphinxcontrib-websupport
 - torchdata
 - wheel
 name: all_cuda-121_arch-x86_64

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

@@ -30,18 +30,15 @@ dependencies:
 - libcusolver-dev
 - libcusparse-dev
 - nbconvert
-- nbsphinx
 - nccl>=2.19
 - ninja
 - notebook>=0.5.0
 - numba>=0.57
 - numpy>=1.23,<3.0a0
-- numpydoc
 - ogb
 - pandas
 - pre-commit
 - pydantic
-- pydata-sphinx-theme
 - pylibcugraphops==25.2.*,>=0.0.0a0
 - pylibraft==25.2.*,>=0.0.0a0
 - pytest
@@ -54,15 +51,10 @@ dependencies:
 - pytorch_geometric>=2.5,<2.6
 - raft-dask==25.2.*,>=0.0.0a0
 - rapids-build-backend>=0.3.0,<0.4.0.dev0
-- recommonmark
 - rmm==25.2.*,>=0.0.0a0
 - scikit-build-core>=0.10.0
 - scipy
 - setuptools>=61.0.0
-- sphinx-copybutton
-- sphinx-markdown-tables
-- sphinx<6
-- sphinxcontrib-websupport
 - torchdata
 - wheel
 name: all_cuda-124_arch-x86_64

dependencies.yaml

@@ -297,15 +297,6 @@ dependencies:
           - breathe
           - doxygen
           - graphviz
-          - ipython
-          - nbsphinx
-          - numpydoc
-          - pydata-sphinx-theme
-          - recommonmark
-          - sphinx-copybutton
-          - sphinx-markdown-tables
-          - sphinx<6
-          - sphinxcontrib-websupport
   py_version:
     specific:
       - output_types: [conda]