Skip to content

Commit

Permalink
Link wholegrah and cugraphops XML docs (#3906)
Browse files Browse the repository at this point in the history
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: #3906
  • Loading branch information
AyodeAwe authored Oct 11, 2023
1 parent 2c1626f commit 81e33bd
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 1 deletion.
7 changes: 7 additions & 0 deletions ci/build_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions conda/environments/all_cuda-118_arch-x86_64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ channels:
- nvidia
dependencies:
- aiohttp
- breathe
- c-compiler
- cmake>=3.26.4
- cuda-version=11.8
Expand Down
1 change: 1 addition & 0 deletions conda/environments/all_cuda-120_arch-x86_64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ channels:
- nvidia
dependencies:
- aiohttp
- breathe
- c-compiler
- cmake>=3.26.4
- cuda-nvcc
Expand Down
1 change: 1 addition & 0 deletions dependencies.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,7 @@ dependencies:
common:
- output_types: [conda]
packages:
- breathe
- doxygen
- graphviz
- ipython
Expand Down
9 changes: 8 additions & 1 deletion docs/cugraph/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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}"
)
)

breathe_projects = {
'libcugraphops': os.environ['XML_DIR_LIBCUGRAPHOPS'],
'libwholegraph': os.environ['XML_DIR_LIBWHOLEGRAPH']
}
breathe_default_project = "libcugraph"

0 comments on commit 81e33bd

Please sign in to comment.