From 81e33bdf3a31d1087bfb33e465862315f252ac4f Mon Sep 17 00:00:00 2001
From: Jake Awe <50372925+AyodeAwe@users.noreply.github.com>
Date: Wed, 11 Oct 2023 08:16:36 -0500
Subject: [PATCH] Link wholegrah and cugraphops XML docs (#3906)

Configures `breathe` and links the uploaded `wholegraph` and `cugraph-ops` XML docs artifacts.

Authors:
  - Jake Awe (https://github.com/AyodeAwe)

Approvers:
  - Brad Rees (https://github.com/BradReesWork)
  - AJ Schmidt (https://github.com/ajschmidt8)

URL: https://github.com/rapidsai/cugraph/pull/3906
---
 ci/build_docs.sh                                 | 7 +++++++
 conda/environments/all_cuda-118_arch-x86_64.yaml | 1 +
 conda/environments/all_cuda-120_arch-x86_64.yaml | 1 +
 dependencies.yaml                                | 1 +
 docs/cugraph/source/conf.py                      | 9 ++++++++-
 5 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/ci/build_docs.sh b/ci/build_docs.sh
index 7b4cf152b4a..e774a6f9871 100755
--- a/ci/build_docs.sh
+++ b/ci/build_docs.sh
@@ -40,6 +40,13 @@ rapids-mamba-retry install "${PYTHON_CHANNEL}/linux-64/cugraph-dgl-*.tar.bz2"
 export RAPIDS_VERSION_NUMBER="23.12"
 export RAPIDS_DOCS_DIR="$(mktemp -d)"
 
+for PROJECT in libcugraphops libwholegraph; do
+  rapids-logger "Download ${PROJECT} xml_tar"
+  TMP_DIR=$(mktemp -d)
+  export XML_DIR_${PROJECT^^}="$TMP_DIR"
+  aws s3 cp --only-show-errors "s3://rapidsai-docs/${PROJECT}/xml_tar/${RAPIDS_VERSION_NUMBER}/xml.tar.gz" - | tar xzf - -C "${TMP_DIR}"
+done
+
 rapids-logger "Build CPP docs"
 pushd cpp/doxygen
 doxygen Doxyfile
diff --git a/conda/environments/all_cuda-118_arch-x86_64.yaml b/conda/environments/all_cuda-118_arch-x86_64.yaml
index 35330db5815..42a218fcf66 100644
--- a/conda/environments/all_cuda-118_arch-x86_64.yaml
+++ b/conda/environments/all_cuda-118_arch-x86_64.yaml
@@ -11,6 +11,7 @@ channels:
 - nvidia
 dependencies:
 - aiohttp
+- breathe
 - c-compiler
 - cmake>=3.26.4
 - cuda-version=11.8
diff --git a/conda/environments/all_cuda-120_arch-x86_64.yaml b/conda/environments/all_cuda-120_arch-x86_64.yaml
index 84967412dc5..0a1774b769f 100644
--- a/conda/environments/all_cuda-120_arch-x86_64.yaml
+++ b/conda/environments/all_cuda-120_arch-x86_64.yaml
@@ -11,6 +11,7 @@ channels:
 - nvidia
 dependencies:
 - aiohttp
+- breathe
 - c-compiler
 - cmake>=3.26.4
 - cuda-nvcc
diff --git a/dependencies.yaml b/dependencies.yaml
index f5067ddae70..7b63f6dc536 100644
--- a/dependencies.yaml
+++ b/dependencies.yaml
@@ -334,6 +334,7 @@ dependencies:
     common:
       - output_types: [conda]
         packages:
+          - breathe
           - doxygen
           - graphviz
           - ipython
diff --git a/docs/cugraph/source/conf.py b/docs/cugraph/source/conf.py
index 58ecca27150..470086b4faa 100644
--- a/docs/cugraph/source/conf.py
+++ b/docs/cugraph/source/conf.py
@@ -37,6 +37,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "breathe",
     "sphinx.ext.intersphinx",
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
@@ -205,4 +206,10 @@ def setup(app):
 # The following is used by sphinx.ext.linkcode to provide links to github
 linkcode_resolve = make_linkcode_resolve(
     "https://github.com/rapidsai/cugraph/blob/{revision}/python/{path}#L{lineno}"
-)
\ No newline at end of file
+)
+
+breathe_projects = {
+    'libcugraphops': os.environ['XML_DIR_LIBCUGRAPHOPS'],
+    'libwholegraph': os.environ['XML_DIR_LIBWHOLEGRAPH']
+}
+breathe_default_project = "libcugraph"