From 5bec5d6e65f1e99ca880be9e02f91e5a92654ef6 Mon Sep 17 00:00:00 2001 From: Jake Awe Date: Mon, 2 Oct 2023 10:44:06 -0700 Subject: [PATCH 1/4] link wholegrah and cugraphops docs --- ci/build_docs.sh | 8 ++++++++ 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, 19 insertions(+), 1 deletion(-) diff --git a/ci/build_docs.sh b/ci/build_docs.sh index 7b4cf152b4a..45f765a693d 100755 --- a/ci/build_docs.sh +++ b/ci/build_docs.sh @@ -40,6 +40,14 @@ rapids-mamba-retry install "${PYTHON_CHANNEL}/linux-64/cugraph-dgl-*.tar.bz2" export RAPIDS_VERSION_NUMBER="23.12" export RAPIDS_DOCS_DIR="$(mktemp -d)" +untar_dest="/tmp/xml_tar" +for PROJECT in libcugraphops libwholegraph; do + rapids-logger "Download ${PROJECT} xml_tar" + dest="${untar_dest}/${PROJECT}" + mkdir -p "$dest" + aws s3 cp --only-show-errors "s3://rapidsai-docs/${PROJECT}/xml_tar/${RAPIDS_VERSION_NUMBER}/xml.tar.gz" - | tar xzf - -C "$dest" +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 c970d0f21cf..28709634fc4 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 d2b26312936..935dcef4c6b 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 4a57835e8ba..812e6ae3748 100644 --- a/dependencies.yaml +++ b/dependencies.yaml @@ -330,6 +330,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..60e1e54f081 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': '/tmp/xml_tar/libcugraphops', + 'libwholegraph': '/tmp/xml_tar/libwholegraph' +} +breathe_default_project = "libcugraph" From e214daa5fd9f88750fc0f012867b3ebc79559a0d Mon Sep 17 00:00:00 2001 From: Jake Awe Date: Tue, 3 Oct 2023 14:40:58 -0500 Subject: [PATCH 2/4] update: shorten code --- ci/build_docs.sh | 6 ++---- docs/cugraph/source/conf.py | 4 ++-- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/ci/build_docs.sh b/ci/build_docs.sh index 45f765a693d..dc2c11cfa0a 100755 --- a/ci/build_docs.sh +++ b/ci/build_docs.sh @@ -40,12 +40,10 @@ rapids-mamba-retry install "${PYTHON_CHANNEL}/linux-64/cugraph-dgl-*.tar.bz2" export RAPIDS_VERSION_NUMBER="23.12" export RAPIDS_DOCS_DIR="$(mktemp -d)" -untar_dest="/tmp/xml_tar" for PROJECT in libcugraphops libwholegraph; do rapids-logger "Download ${PROJECT} xml_tar" - dest="${untar_dest}/${PROJECT}" - mkdir -p "$dest" - aws s3 cp --only-show-errors "s3://rapidsai-docs/${PROJECT}/xml_tar/${RAPIDS_VERSION_NUMBER}/xml.tar.gz" - | tar xzf - -C "$dest" + export XML_DIR_${PROJECT^^}=$(mktemp -d) + aws s3 cp --only-show-errors "s3://rapidsai-docs/${PROJECT}/xml_tar/${RAPIDS_VERSION_NUMBER}/xml.tar.gz" - | tar xzf - -C "$XML_DIR_${PROJECT^^}" done rapids-logger "Build CPP docs" diff --git a/docs/cugraph/source/conf.py b/docs/cugraph/source/conf.py index 60e1e54f081..470086b4faa 100644 --- a/docs/cugraph/source/conf.py +++ b/docs/cugraph/source/conf.py @@ -209,7 +209,7 @@ def setup(app): ) breathe_projects = { - 'libcugraphops': '/tmp/xml_tar/libcugraphops', - 'libwholegraph': '/tmp/xml_tar/libwholegraph' + 'libcugraphops': os.environ['XML_DIR_LIBCUGRAPHOPS'], + 'libwholegraph': os.environ['XML_DIR_LIBWHOLEGRAPH'] } breathe_default_project = "libcugraph" From f6068875c75b4dc80d75d7a1a3f5047ef3908350 Mon Sep 17 00:00:00 2001 From: Jake Awe Date: Wed, 4 Oct 2023 09:16:28 -0500 Subject: [PATCH 3/4] fix unbound var --- ci/build_docs.sh | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/ci/build_docs.sh b/ci/build_docs.sh index dc2c11cfa0a..fb5d31014c1 100755 --- a/ci/build_docs.sh +++ b/ci/build_docs.sh @@ -42,8 +42,9 @@ export RAPIDS_DOCS_DIR="$(mktemp -d)" for PROJECT in libcugraphops libwholegraph; do rapids-logger "Download ${PROJECT} xml_tar" - export XML_DIR_${PROJECT^^}=$(mktemp -d) - aws s3 cp --only-show-errors "s3://rapidsai-docs/${PROJECT}/xml_tar/${RAPIDS_VERSION_NUMBER}/xml.tar.gz" - | tar xzf - -C "$XML_DIR_${PROJECT^^}" + project_dir="XML_DIR_${PROJECT^^}" + declare "$project_dir=$(mktemp -d)" && export "${project_dir}" + aws s3 cp --only-show-errors "s3://rapidsai-docs/${PROJECT}/xml_tar/${RAPIDS_VERSION_NUMBER}/xml.tar.gz" - | tar xzf - -C "${!project_dir}" done rapids-logger "Build CPP docs" From 11224b59f4908066707c93b01c7cc95648a9c180 Mon Sep 17 00:00:00 2001 From: ayodeawe Date: Thu, 5 Oct 2023 11:02:08 -0500 Subject: [PATCH 4/4] review --- ci/build_docs.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ci/build_docs.sh b/ci/build_docs.sh index fb5d31014c1..e774a6f9871 100755 --- a/ci/build_docs.sh +++ b/ci/build_docs.sh @@ -42,9 +42,9 @@ export RAPIDS_DOCS_DIR="$(mktemp -d)" for PROJECT in libcugraphops libwholegraph; do rapids-logger "Download ${PROJECT} xml_tar" - project_dir="XML_DIR_${PROJECT^^}" - declare "$project_dir=$(mktemp -d)" && export "${project_dir}" - aws s3 cp --only-show-errors "s3://rapidsai-docs/${PROJECT}/xml_tar/${RAPIDS_VERSION_NUMBER}/xml.tar.gz" - | tar xzf - -C "${!project_dir}" + 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"