Skip to content

Commit 1f1abed

Browse files
authored
Merge pull request #148 from rapidsai/branch-25.08
[RELEASE] cugraph-docs v25.08
2 parents 106903c + 176233f commit 1f1abed

48 files changed

Lines changed: 515 additions & 256 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/build.yaml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,21 @@ on:
99
workflow_dispatch:
1010
inputs:
1111
branch:
12+
description: |
13+
branch: git branch the workflow run targets.
14+
Required even when 'sha' is provided because it is also used for organizing artifacts.
1215
required: true
1316
type: string
1417
date:
18+
description: "date: Date (YYYY-MM-DD) this run is for. Used to organize artifacts produced by nightly builds"
1519
required: true
1620
type: string
1721
sha:
22+
description: "sha: full git commit SHA to check out"
1823
required: true
1924
type: string
2025
build_type:
26+
description: "build_type: one of [branch, nightly, pull-request]"
2127
type: string
2228
default: nightly
2329

@@ -29,7 +35,7 @@ jobs:
2935
docs-build:
3036
if: github.ref_type == 'branch'
3137
secrets: inherit
32-
uses: rapidsai/shared-workflows/.github/workflows/custom-job.yaml@branch-25.06
38+
uses: rapidsai/shared-workflows/.github/workflows/custom-job.yaml@branch-25.08
3339
with:
3440
arch: "amd64"
3541
branch: ${{ inputs.branch }}

.github/workflows/pr.yaml

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
- checks
1717
- docs-build
1818
secrets: inherit
19-
uses: rapidsai/shared-workflows/.github/workflows/pr-builder.yaml@branch-25.06
19+
uses: rapidsai/shared-workflows/.github/workflows/pr-builder.yaml@branch-25.08
2020
if: always()
2121
with:
2222
needs: ${{ toJSON(needs) }}
@@ -31,31 +31,26 @@ jobs:
3131
checks:
3232
secrets: inherit
3333
needs: telemetry-setup
34-
uses: rapidsai/shared-workflows/.github/workflows/checks.yaml@branch-25.06
34+
uses: rapidsai/shared-workflows/.github/workflows/checks.yaml@branch-25.08
3535
with:
3636
enable_check_generated_files: false
3737
ignored_pr_jobs: "telemetry-summarize"
3838
docs-build:
3939
needs: checks
4040
secrets: inherit
41-
uses: rapidsai/shared-workflows/.github/workflows/custom-job.yaml@branch-25.06
41+
uses: rapidsai/shared-workflows/.github/workflows/custom-job.yaml@branch-25.08
4242
with:
4343
build_type: pull-request
4444
node_type: "gpu-l4-latest-1"
4545
arch: "amd64"
4646
container_image: "rapidsai/ci-conda:latest"
4747
script: "ci/build_docs.sh"
4848
telemetry-summarize:
49-
runs-on: ubuntu-latest
49+
# This job must use a self-hosted runner to record telemetry traces.
50+
runs-on: linux-amd64-cpu4
5051
needs: pr-builder
51-
if: always()
52+
if: ${{ vars.TELEMETRY_ENABLED == 'true' && !cancelled() }}
5253
continue-on-error: true
5354
steps:
54-
- name: Load stashed telemetry env vars
55-
uses: rapidsai/shared-actions/telemetry-dispatch-load-base-env-vars@main
56-
with:
57-
load_service_name: true
5855
- name: Telemetry summarize
59-
uses: rapidsai/shared-actions/telemetry-dispatch-write-summary@main
60-
with:
61-
cert_concat: "${{ secrets.OTEL_EXPORTER_OTLP_CA_CERTIFICATE }};${{ secrets.OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE }};${{ secrets.OTEL_EXPORTER_OTLP_CLIENT_KEY }}"
56+
uses: rapidsai/shared-actions/telemetry-dispatch-summarize@main

.pre-commit-config.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ repos:
77
- id: verify-alpha-spec
88
- id: verify-copyright
99
- repo: https://github.com/rapidsai/dependency-file-generator
10-
rev: v1.18.1
10+
rev: v1.19.0
1111
hooks:
1212
- id: rapids-dependency-file-generator
1313
args: ["--clean"]
@@ -16,7 +16,6 @@ repos:
1616
hooks:
1717
- id: shellcheck
1818
args: ["--severity=warning"]
19-
files: ^ci/
2019

2120
default_language_version:
2221
python: python3

CHANGELOG.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
1+
# cugraph-docs 25.08.00 (6 Aug 2025)
2+
3+
## 🚨 Breaking Changes
4+
5+
- remove cugraph-dgl references ([#146](https://github.com/rapidsai/cugraph-docs/pull/146)) [@jameslamb](https://github.com/jameslamb)
6+
7+
## 🐛 Bug Fixes
8+
9+
- Update telemetry-summarize ([#136](https://github.com/rapidsai/cugraph-docs/pull/136)) [@msarahan](https://github.com/msarahan)
10+
11+
## 📖 Documentation
12+
13+
- added new blogs for 2025 and fixed cuda docs per review comment ([#143](https://github.com/rapidsai/cugraph-docs/pull/143)) [@acostadon](https://github.com/acostadon)
14+
- Removing CUDA 11 references and fixing outdated wholegraph info ([#141](https://github.com/rapidsai/cugraph-docs/pull/141)) [@acostadon](https://github.com/acostadon)
15+
- Adds Commmunity and Louvain landing pages ([#139](https://github.com/rapidsai/cugraph-docs/pull/139)) [@acostadon](https://github.com/acostadon)
16+
- add docs on CI workflow inputs ([#137](https://github.com/rapidsai/cugraph-docs/pull/137)) [@jameslamb](https://github.com/jameslamb)
17+
- Fixing links issues with Sphinx ([#134](https://github.com/rapidsai/cugraph-docs/pull/134)) [@acostadon](https://github.com/acostadon)
18+
- minimal path change and added hyphen to verify version ([#133](https://github.com/rapidsai/cugraph-docs/pull/133)) [@acostadon](https://github.com/acostadon)
19+
- changed the formulas to match myst-parser ([#132](https://github.com/rapidsai/cugraph-docs/pull/132)) [@acostadon](https://github.com/acostadon)
20+
21+
## 🛠️ Improvements
22+
23+
- remove cugraph-dgl references ([#146](https://github.com/rapidsai/cugraph-docs/pull/146)) [@jameslamb](https://github.com/jameslamb)
24+
- Remove channels ([#138](https://github.com/rapidsai/cugraph-docs/pull/138)) [@vyasr](https://github.com/vyasr)
25+
- Use CUDA 12.9 in Conda, Devcontainers, Spark, GHA, etc. ([#135](https://github.com/rapidsai/cugraph-docs/pull/135)) [@jakirkham](https://github.com/jakirkham)
26+
- refactor(shellcheck): fix all shellcheck warnings/errors ([#131](https://github.com/rapidsai/cugraph-docs/pull/131)) [@gforsyth](https://github.com/gforsyth)
27+
- Forward-merge branch-25.06 into branch-25.08 ([#119](https://github.com/rapidsai/cugraph-docs/pull/119)) [@gforsyth](https://github.com/gforsyth)
28+
129
# cugraph-docs 25.06.00 (5 Jun 2025)
230

331
## 🐛 Bug Fixes

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
25.06.00
1+
25.08.00

build.sh

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ARGS=$*
1616

1717
# NOTE: ensure all dir changes are relative to the location of this
1818
# script, and that this script resides in the repo dir!
19-
REPODIR=$(cd $(dirname $0); pwd)
19+
REPODIR=$(cd "$(dirname "$0")"; pwd)
2020

2121
RAPIDS_VERSION="$(sed -E -e 's/^([0-9]{2})\.([0-9]{2})\.([0-9]{2}).*$/\1.\2/' VERSION)"
2222

@@ -37,7 +37,6 @@ HELP="$0 [<target> ...] [<flag> ...]
3737
clean - remove all existing build artifacts and configuration (start over)
3838
docs - build the docs (default)
3939
and <flag> is:
40-
-v - verbose build mode
4140
--clean - clean
4241
-h - print this text
4342
@@ -46,15 +45,12 @@ HELP="$0 [<target> ...] [<flag> ...]
4645
"
4746

4847

49-
# Set defaults for vars modified by flags to this script
50-
VERBOSE_FLAG=""
51-
5248
function hasArg {
53-
(( ${NUMARGS} != 0 )) && (echo " ${ARGS} " | grep -q " $1 ")
49+
(( NUMARGS != 0 )) && (echo " ${ARGS} " | grep -q " $1 ")
5450
}
5551

5652
function buildDefault {
57-
(( ${NUMARGS} == 0 )) || !(echo " ${ARGS} " | grep -q " [^-][a-zA-Z0-9\_\-]\+ ")
53+
(( NUMARGS == 0 )) || ! (echo " ${ARGS} " | grep -q " [^-][a-zA-Z0-9\_\-]\+ ")
5854
}
5955

6056

@@ -64,7 +60,7 @@ if hasArg -h || hasArg --help; then
6460
fi
6561

6662
# Check for valid usage
67-
if (( ${NUMARGS} != 0 )); then
63+
if (( NUMARGS != 0 )); then
6864
for a in ${ARGS}; do
6965
if ! (echo "${VALIDARGS}" | grep -q "^[[:blank:]]*${a}$"); then
7066
echo "Invalid option: ${a}"
@@ -73,19 +69,12 @@ if (( ${NUMARGS} != 0 )); then
7369
done
7470
fi
7571

76-
# Process flags
77-
if hasArg -v; then
78-
VERBOSE_FLAG="-v"
79-
fi
80-
81-
82-
8372
if hasArg clean; then
8473
# Ignore errors for clean since missing files, etc. are not failures
8574
set +e
8675

8776
# Clean up the docs
88-
cd ${REPODIR}/docs/cugraph-docs
77+
cd "${REPODIR}"/docs/cugraph-docs
8978
make clean
9079
# Go back to failing on first error for all other operations
9180
set -e
@@ -94,13 +83,13 @@ fi
9483
# Build the docs
9584
# C/C++?CUDA libraries
9685
if hasArg docs || buildDefault; then
97-
PROJ_LIST=("libcugraph libwholegraph")
98-
for PROJECT in ${PROJ_LIST}; do
86+
PROJ_LIST=("libcugraph" "libwholegraph")
87+
for PROJECT in "${PROJ_LIST[@]}"; do
9988
echo "PROJECT IS ${PROJECT}"
10089
XML_DIR="${REPODIR}/docs/cugraph-docs/${PROJECT}"
10190
rm -rf "${XML_DIR}"
10291
mkdir -p "${XML_DIR}"
103-
export XML_DIR_${PROJECT^^}="$XML_DIR"
92+
export XML_DIR_"${PROJECT^^}"="$XML_DIR"
10493
echo "Pulling https://d1664dvumjb44w.cloudfront.net/${PROJECT}/xml_tar/${RAPIDS_VERSION}/xml.tar.gz"
10594
curl -O "https://d1664dvumjb44w.cloudfront.net/${PROJECT}/xml_tar/${RAPIDS_VERSION}/xml.tar.gz"
10695

@@ -114,6 +103,6 @@ if hasArg docs || buildDefault; then
114103

115104
#export XML_DIR_LIBCUGRAPH="${REPODIR}/cpp/doxygen/xml"
116105

117-
cd ${REPODIR}/docs/cugraph-docs
106+
cd "${REPODIR}"/docs/cugraph-docs
118107
make html
119-
fi
108+
fi

ci/release/update-version.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ NEXT_SHORT_TAG_PEP440=$(python -c "from packaging.version import Version; print(
4444

4545
DEPENDENCIES=(
4646
cugraph
47-
cugraph-dgl
4847
cugraph-pyg
4948
libcugraph
5049
libcugraph_etl

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

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,26 @@ channels:
44
- pyg
55
- rapidsai
66
- rapidsai-nightly
7-
- dask/label/dev
87
- conda-forge
9-
- nvidia
108
dependencies:
119
- breathe>=4.35
1210
- cuda-version=12.9
13-
- cugraph-dgl==25.6.*,>=0.0.0a0
14-
- cugraph-pyg==25.6.*,>=0.0.0a0
15-
- cugraph==25.6.*,>=0.0.0a0
16-
- dglteam/label/th24_cu124::dgl
11+
- cugraph-pyg==25.8.*,>=0.0.0a0
12+
- cugraph==25.8.*,>=0.0.0a0
1713
- doxygen
1814
- graphviz
1915
- ipython
20-
- libcugraph==25.6.*,>=0.0.0a0
21-
- libcugraph_etl==25.6.*,>=0.0.0a0
16+
- libcugraph==25.8.*,>=0.0.0a0
17+
- libcugraph_etl==25.8.*,>=0.0.0a0
18+
- myst-parser>=0.13
2219
- nbsphinx
2320
- numpydoc
2421
- pre-commit
2522
- pydata-sphinx-theme
26-
- pylibcugraph==25.6.*,>=0.0.0a0
27-
- pylibwholegraph==25.6.*,>=0.0.0a0
28-
- recommonmark
23+
- pylibcugraph==25.8.*,>=0.0.0a0
24+
- pylibwholegraph==25.8.*,>=0.0.0a0
25+
- sphinx
2926
- sphinx-copybutton
3027
- sphinx-markdown-tables
31-
- sphinx>=8,<8.2.0
3228
- sphinxcontrib-websupport
3329
name: all_cuda-129_arch-x86_64

dependencies.yaml

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,7 @@ channels:
2626
- pyg
2727
- rapidsai
2828
- rapidsai-nightly
29-
- dask/label/dev
3029
- conda-forge
31-
- nvidia
3230
dependencies:
3331
checks:
3432
common:
@@ -68,14 +66,13 @@ dependencies:
6866
- doxygen
6967
- graphviz
7068
- ipython
69+
- myst-parser>=0.13
7170
- nbsphinx
7271
- numpydoc
7372
- pydata-sphinx-theme
74-
- recommonmark
7573
- sphinx-copybutton
7674
- sphinx-markdown-tables
77-
# the ceiling on sphinx can be removed when https://github.com/spatialaudio/nbsphinx/issues/825 is resolved
78-
- sphinx>=8,<8.2.0
75+
- sphinx
7976
- sphinxcontrib-websupport
8077

8178
# this repo only uses conda and 1 major version of CUDA, so
@@ -84,11 +81,9 @@ dependencies:
8481
common:
8582
- output_types: [conda]
8683
packages:
87-
- cugraph==25.6.*,>=0.0.0a0
88-
- cugraph-dgl==25.6.*,>=0.0.0a0
89-
- cugraph-pyg==25.6.*,>=0.0.0a0
90-
- 'dglteam/label/th24_cu124::dgl'
91-
- libcugraph==25.6.*,>=0.0.0a0
92-
- libcugraph_etl==25.6.*,>=0.0.0a0
93-
- pylibcugraph==25.6.*,>=0.0.0a0
94-
- pylibwholegraph==25.6.*,>=0.0.0a0
84+
- cugraph==25.8.*,>=0.0.0a0
85+
- cugraph-pyg==25.8.*,>=0.0.0a0
86+
- libcugraph==25.8.*,>=0.0.0a0
87+
- libcugraph_etl==25.8.*,>=0.0.0a0
88+
- pylibcugraph==25.8.*,>=0.0.0a0
89+
- pylibwholegraph==25.8.*,>=0.0.0a0
76.4 KB
Loading

0 commit comments

Comments
 (0)