Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MAINT: update rapids-dependency-file-generator to 1.17.1, fix docs builds #14

Merged
merged 5 commits into from
Feb 24, 2025

Conversation

jameslamb
Copy link
Member

@jameslamb jameslamb commented Feb 21, 2025

Contributes to rapidsai/build-planning#155

Miscellaneous small changes:

Signed-off-by: James Lamb <jlamb@nvidia.com>
@jameslamb jameslamb added improvement Improves an existing functionality non-breaking Introduces a non-breaking change labels Feb 21, 2025
Signed-off-by: James Lamb <jlamb@nvidia.com>
@jameslamb jameslamb changed the title WIP: update rapids-dependency-file-generator to 1.17.1 MAINT: update rapids-dependency-file-generator to 1.17.1, fix docs builds Feb 21, 2025
../../CONTRIBUTING.md
Copy link
Member Author

Choose a reason for hiding this comment

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

I saw 2 warnings treated as errors in the docs builds:

/__w/legate-raft/legate-raft/docs/source/CONTRIBUTING.md:25: WARNING: Unknown source document '/__w/legate-raft/legate-raft/README' [myst.xref_missing]
/__w/legate-raft/legate-raft/docs/source/README.md:49: WARNING: Unknown source document '/__w/legate-raft/legate-raft/CONTRIBTING' [myst.xref_missing]

(build link)

Renaming CONTRIBTING.md to CONTRIBUTING.md should fix one of them (the reference in docs/source/index.rst was inconsistent with the actual file name), and maybe both?

Copy link
Member Author

Choose a reason for hiding this comment

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

Ahhhh ok, so I still think this renaming (to fix the spelling error) was a good thing, but it did not resolve the failure.

Interesting to note that the docs this is complaining about are totally working in the rendered docs. You can go to https://rapidsai.github.io/legate-raft/README.html and try clicking "our guide for contributing to legate-raft" ... it leads to https://rapidsai.github.io/legate-raft/CONTRIBUTING.html successfully.

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh! @seberg I just saw your comment here: rapidsai/legate-boost#212 (comment)

I guess it's sphinx 8.2.0 that is causing these warnings? I'll try pinning here too.

Copy link
Contributor

Choose a reason for hiding this comment

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

Right, that was one of the things I saw in legate-df.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah got it, ok! I've pushed a sphinx<8.2.0 pin here, it looks like it'd fix docs builds: https://github.com/rapidsai/legate-raft/actions/runs/13502337421/job/37726967372?pr=14

Signed-off-by: James Lamb <jlamb@nvidia.com>
Signed-off-by: James Lamb <jlamb@nvidia.com>
Signed-off-by: James Lamb <jlamb@nvidia.com>
@jameslamb jameslamb marked this pull request as ready for review February 24, 2025 16:59
@jameslamb jameslamb requested a review from seberg February 24, 2025 16:59
Copy link
Contributor

@seberg seberg left a comment

Choose a reason for hiding this comment

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

LGTM, I checked that the modified links work in the artifact.

@jameslamb jameslamb merged commit dd6cde5 into rapidsai:main Feb 24, 2025
10 checks passed
@jameslamb jameslamb deleted the sphinx-pin branch February 24, 2025 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement Improves an existing functionality non-breaking Introduces a non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants