Add docs build job

.github/workflows/build.yaml

@@ -45,3 +45,13 @@ jobs:
       branch: ${{ inputs.branch }}
       date: ${{ inputs.date }}
       sha: ${{ inputs.sha }}
+  docs-build:
+    if: ${{ startsWith(github.ref, 'refs/heads/branch-') }}
+    secrets: inherit
+    uses: rapidsai/shared-action-workflows/.github/workflows/custom-job.yaml@branch-23.04
+    with:
+      build_type: branch
+      node_type: "cpu4"
+      arch: "amd64"
+      container_image: "rapidsai/ci:latest"
+      run_script: "ci/build_docs.sh"

.github/workflows/pr.yaml

@@ -15,6 +15,7 @@ jobs:
       - checks
       - conda-cpp-build
       - conda-cpp-tests
+      - docs-build
     secrets: inherit
     uses: rapidsai/shared-action-workflows/.github/workflows/pr-builder.yaml@branch-23.04
   checks:
@@ -32,3 +33,13 @@ jobs:
     uses: rapidsai/shared-action-workflows/.github/workflows/conda-cpp-tests.yaml@branch-23.04
     with:
       build_type: pull-request
+  docs-build:
+    needs: conda-cpp-build
+    secrets: inherit
+    uses: rapidsai/shared-action-workflows/.github/workflows/custom-job.yaml@branch-23.04
+    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,31 @@
+#!/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
+
+VERSION_NUMBER=$(rapids-get-rapids-version-from-git)
+
+rapids-logger "Build Sphinx docs"
+pushd docs
+sphinx-build -b dirhtml . _html -W
+sphinx-build -b text . _text -W
+popd
+
+
+if [[ ${RAPIDS_BUILD_TYPE} == "branch" ]]; then
+  aws s3 sync --delete docs/_html "s3://rapidsai-docs/rapids-cmake/${VERSION_NUMBER}/html"
+  aws s3 sync --delete docs/_text "s3://rapidsai-docs/rapids-cmake/${VERSION_NUMBER}/txt"
+fi

dependencies.yaml

@@ -5,12 +5,18 @@ files:
     includes:
       - build
       - cudatoolkit
+      - docs
       - test
   checks:
     output: none
     includes:
       - build
       - style_checks
+  docs:
+    output: none
+    includes:
+      - cudatoolkit
+      - docs
 channels:
   - rapidsai
   - conda-forge
@@ -51,6 +57,16 @@ dependencies:
               cuda: "11.8"
             packages:
               - cudatoolkit=11.8
+  docs:
+    common:
+      - output_types: [conda]
+        packages:
+          - pip
+          - pip:
+            - sphinxcontrib-moderncmakedomain
+          - sphinx
+          - sphinx-copybutton
+          - sphinx_rtd_theme
   test:
     common:
       - output_types: [conda, requirements]

docs/conf.py

@@ -1,3 +1,5 @@
+# Copyright (c) 2023, NVIDIA CORPORATION.
+#
 # Configuration file for the Sphinx documentation builder.
 #
 # This file only contains a selection of the most common options. For a full
@@ -10,12 +12,12 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-import os
+import sphinx_rtd_theme
 
 # -- Project information -----------------------------------------------------
 
 project = "rapids-cmake"
-copyright = "2021, NVIDIA"
+copyright = "2021-2023, NVIDIA"
 author = "NVIDIA"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -64,7 +66,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -84,20 +86,8 @@
 # a list of builtin themes.
 #
 
-html_theme = "sphinx_pydata_theme"
-
-# on_rtd is whether we are on readthedocs.org
-on_rtd = os.environ.get("READTHEDOCS", None) == "True"
-
-if not on_rtd:
-    # only import and set the theme if we're building docs locally
-    # otherwise, readthedocs.org uses their theme by default,
-    # so no need to specify it
-    import sphinx_rtd_theme
-
-    html_theme = "sphinx_rtd_theme"
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

rapids-cmake/cython/add_rpath_entries.cmake

@@ -1,5 +1,5 @@
 # =============================================================================
-# Copyright (c) 2022, NVIDIA CORPORATION.
+# Copyright (c) 2022-2023, NVIDIA CORPORATION.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 # in compliance with the License. You may obtain a copy of the License at
@@ -17,25 +17,24 @@ include_guard(GLOBAL)
 #[=======================================================================[.rst:
 rapids_cython_add_rpath_entries
 -------------------------------
-
 .. versionadded:: v22.12.00
 
 Set the RPATH entries for all targets associated with a provided associated target.
 
 .. code-block:: cmake
 
-rapids_cython_add_rpath_entries(
-    TARGET <associated_target>
-    PATHS <path1> <path2> ...
-    [ROOT_DIRECTORY <root-dir>]
-)
+  rapids_cython_add_rpath_entries(
+      TARGET <associated_target>
+      PATHS <path1> <path2> ...
+      [ROOT_DIRECTORY <root-dir>]
+  )
 
 This function will affect all targets created up to the point of this call. It
 will have no effect on targets created afterwards.
 
 ``TARGET``
   The associated target for which we are setting RPATH entries. Any target
-  created using :code:command:`rapids_cython_create_modules` with the argument
+  created using :cmake:command:`rapids_cython_create_modules` with the argument
   `ASSOCIATED_TARGET associated_target` will have its RPATH entries updated.
 
 ``PATHS``

rapids-cmake/cython/create_modules.cmake

@@ -1,5 +1,5 @@
 # =============================================================================
-# Copyright (c) 2022, NVIDIA CORPORATION.
+# Copyright (c) 2022-2023, NVIDIA CORPORATION.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 # in compliance with the License. You may obtain a copy of the License at
@@ -61,7 +61,8 @@ $ORIGIN.
   A list of targets that are associated with the Cython targets created in this
   function. The target<-->associated target mapping is stored and may be
   leveraged by the following functions:
-  - :code:command:`rapids_cython_add_rpath_entries` accepts a path for an
+
+  - :cmake:command:`rapids_cython_add_rpath_entries` accepts a path for an
     associated target and updates the RPATH of each target with which that
     associated target is associated.