Skip to content

add docs-building CI#46

Merged
rapids-bot[bot] merged 21 commits intorapidsai:branch-25.02from
jameslamb:ci/add-docs-build
Dec 18, 2024
Merged

add docs-building CI#46
rapids-bot[bot] merged 21 commits intorapidsai:branch-25.02from
jameslamb:ci/add-docs-build

Conversation

@jameslamb
Copy link
Copy Markdown
Member

@jameslamb jameslamb commented Sep 16, 2024

Replaces #44.

Trying a new PR that enables docs builds on PRs and branch builds.

@jameslamb jameslamb added improvement Improves an existing functionality non-breaking Introduces a non-breaking change labels Sep 16, 2024
@jameslamb jameslamb requested a review from a team as a code owner September 16, 2024 20:26
@jameslamb jameslamb requested review from KyleFromNVIDIA and removed request for a team September 16, 2024 20:26
@jameslamb jameslamb marked this pull request as draft September 16, 2024 20:27
@jameslamb jameslamb removed the request for review from KyleFromNVIDIA September 16, 2024 20:27
@jameslamb jameslamb requested a review from acostadon September 16, 2024 20:34
@acostadon
Copy link
Copy Markdown
Contributor

acostadon commented Sep 16, 2024

I see checks !!!

acostadon
acostadon approved these changes Sep 16, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@acostadon acostadon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great thanks a ton

@jameslamb jameslamb self-assigned this Sep 17, 2024
jameslamb
jameslamb commented Sep 20, 2024
View reviewed changes
Comment thread ci/build_docs.sh Outdated
@jameslamb jameslamb mentioned this pull request Sep 27, 2024
Merged
@jameslamb jameslamb mentioned this pull request Oct 10, 2024
Closed
@jameslamb jameslamb assigned AyodeAwe and unassigned jameslamb Dec 5, 2024
@AyodeAwe AyodeAwe changed the base branch from branch-24.10 to branch-25.02 December 13, 2024 17:03
@AyodeAwe
Copy link
Copy Markdown
Contributor

AyodeAwe commented Dec 13, 2024

Looks like the xml tar for wholegraph is missing for 25.02:

https://github.com/rapidsai/cugraph-docs/actions/runs/12319865689/job/34387907292?pr=46#step:10:9373

cc @jameslamb this is supposed to be uploaded from the cugraph-gnn repository right?

@jameslamb
Copy link
Copy Markdown
Member Author

jameslamb commented Dec 13, 2024

cc @jameslamb this is supposed to be uploaded from the cugraph-gnn repository right?

Yep, that's where wholegraph development has moved.

But I didn't move any docs XML publishing stuff into that repo when we were migrating from cugraph, because I didn't know what specifically was necessary for cugraph-docs.

I suspect you just need to update https://github.com/rapidsai/cugraph-gnn/blob/branch-25.02/build.sh with code similar to this:

https://github.com/rapidsai/cugraph/blob/3ad4949f2e119f881361500172a04d2d4b243f31/build.sh#L334-L344

(and then remove that commented-out code from the cugraph repo)

@ me any time for ci-codeowners / packaging-codeowners reviews.

@AyodeAwe
Copy link
Copy Markdown
Contributor

AyodeAwe commented Dec 13, 2024 •
edited
Loading

@jameslamb quick question (asking you this since you were much involved in cugraph/gnn restructuring):

The cugraph-gnn repo seems to have no docs build workflow (typically implemented in a ci/build_docs.sh file). Do you know why?

It seems like we need to set that before we can get this PR going. Essentially, it is from that implementation that wholegraph xml tars should be uploaded.

@jameslamb
Copy link
Copy Markdown
Member Author

jameslamb commented Dec 13, 2024

The cugraph-gnn repo seems to have no docs build workflow (typically implemented in a ci/build_docs.sh file). Do you know why?

That's also an artifact of being unsure about what the plan was for cugraph-docs. I focused on just getting builds and tests running there ahead of 24.12 burndown, and then moved on to other time-sensitive things for the release.

Since you're now more familiar than I am with the plan for cugraph-docs and how it'll affect what shows up at https://docs.rapids.ai/api/, could you make that initial cugraph-gnn PR? I'm happy to review or pair any time.

@AyodeAwe
Copy link
Copy Markdown
Contributor

AyodeAwe commented Dec 13, 2024

Yep. Looking into it 👍🏿

@jameslamb jameslamb mentioned this pull request Dec 16, 2024
Closed
@jameslamb
Copy link
Copy Markdown
Member Author

jameslamb commented Dec 16, 2024

The cugraph-gnn repo seems to have no docs build workflow (typically implemented in a ci/build_docs.sh file).

...

...It seems like we need to set that before we can get this PR going.

This is being tracked in rapidsai/cugraph-gnn#94 and I'm working on it.

@jameslamb jameslamb mentioned this pull request Dec 16, 2024
Merged
rapids-bot Bot pushed a commit to rapidsai/cugraph-gnn that referenced this pull request Dec 17, 2024
@jameslamb
build libwholegraph docs in CI (#96)
cc1bab9 
Fixes #94

Uploads API docs for `libwholegraph`, to be used by rapidsai/cugraph-docs#46

Also removes `sphinx` dependencies... this repo only needs to produce Doxygen docs for `libwholegraph`, all the other Sphinx stuff will be done in https://github.com/rapidsai/cugraph-docs.

Authors:
  - James Lamb (https://github.com/jameslamb)
  - Don Acosta (https://github.com/acostadon)

Approvers:
  - Don Acosta (https://github.com/acostadon)
  - Bradley Dice (https://github.com/bdice)

URL: #96
@jameslamb jameslamb mentioned this pull request Dec 18, 2024
Merged
@jameslamb
Copy link
Copy Markdown
Member Author

jameslamb commented Dec 18, 2024

/ok to test

@jameslamb jameslamb marked this pull request as ready for review December 18, 2024 17:05
@jameslamb jameslamb requested a review from a team as a code owner December 18, 2024 17:05
acostadon
acostadon approved these changes Dec 18, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@acostadon acostadon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great

@jameslamb
Copy link
Copy Markdown
Member Author

jameslamb commented Dec 18, 2024

/merge

@rapids-bot rapids-bot Bot merged commit 2203a93 into rapidsai:branch-25.02 Dec 18, 2024
@jameslamb jameslamb deleted the ci/add-docs-build branch December 18, 2024 17:18
@AyodeAwe
Copy link
Copy Markdown
Contributor

AyodeAwe commented Jan 2, 2025

This is being tracked in rapidsai/cugraph-gnn#94 and I'm working on it.

Thanks for working on this while I was OOO @jameslamb!

@jameslamb
Copy link
Copy Markdown
Member Author

jameslamb commented Jan 2, 2025

No prob, thanks for getting it to this stage for me to pick up! We've gotten pretty far and have docs publishing from this repo now 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@msarahan msarahan msarahan approved these changes

@acostadon acostadon acostadon approved these changes

Assignees

@AyodeAwe AyodeAwe

Labels

improvement Improves an existing functionality non-breaking Introduces a non-breaking change

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@jameslamb @acostadon @AyodeAwe @msarahan @BradReesWork