Treat warnings as errors in doc builds + MG ANNs Python API doc update#1350
Conversation
cjnolet
added
improvement
benfred
left a comment
benfred
left a comment
There was a problem hiding this comment.
Changes look good to me -
I tried to make the docs build fail on warnings w/ #1301 so that these kind of errors wouldn't happen in the future. I think I just updated ./build.sh in that PR - and it looks like I also needed to update ci\build_docs.sh in the same way ( sphinx-build -W) to get CI to treat docs warnings as errors.
Can we also change the ci/docs_build.sh to enable warnings as errors in this PR, so that this kind of error won't happen again in the future?
viclafargue
force-pushed
the
update-mg-python-doc
branch
from
7f000d3 to
8e63d0d
Compare
jameslamb
left a comment
jameslamb
left a comment
There was a problem hiding this comment.
Left one suggestion for your consideration.
Please also update the PR title and add a short description, so others finding this from search and the git history can understand what its purpose was.
I think it is something like "treat warnings as errors in doc builds".
Approving so you don't need another review from me to merge, but please @ me if you have any questions.
| rapids-logger "Build Python docs" | ||
| pushd docs | ||
| sphinx-build -b dirhtml source _html | ||
| sphinx-build -W -b dirhtml source _html |
There was a problem hiding this comment.
Consider putting this into the Makefile and using make dirhtml in any scripts where you want to build the docs:
Line 5 in c07ab70
That way, the settings would apply still if you switched from dirhtml to html, and you wouldn't have to keep this in sync with this other use:
Line 520 in c07ab70
See how cudf does this for an example:
There was a problem hiding this comment.
@viclafargue do you mind creating a Github issue for this?
viclafargue
changed the title
jameslamb
left a comment
jameslamb
left a comment
There was a problem hiding this comment.
Thanks for the changes! This looks like what I was expecting, and the preview at https://downloads.rapids.ai/ci/cuvs/pull-request/1350/750f577/docs/cuvs/html/ all looks OK to me.
|
One Java test failed: That's unlikely to be related to these changes, and I've seen that test be flaky before (#1326 (comment)), so I re-ran that job for you. Hopefully we'll see it pass. |
|
/merge |
rapids-bot
Bot
merged commit fdb8bfb
into
rapidsai:branch-25.10
github-project-automation
Bot
moved this from In Progress
to Done
in Unstructured Data Processing
rapidsai#1350) This PR : - updates doc build to treat warnings as errors - fixes an issue in the MG ANNs Python API doc - fixes several doc issues that resulted in warnings Closes rapidsai#1382 Authors: - Victor Lafargue (https://github.com/viclafargue) Approvers: - Ben Frederickson (https://github.com/benfred) - James Lamb (https://github.com/jameslamb) - Corey J. Nolet (https://github.com/cjnolet) URL: rapidsai#1350
4 participants
This PR :
Closes #1382