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.

Sign up for GitHub

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

Jump to bottom

Sphinx warnings as errors #4585

Merged
merged 16 commits into from
Mar 28, 2022
Merged

Sphinx warnings as errors #4585

merged 16 commits into from
Mar 28, 2022
+50 −28

Conversation

RAMitchell
Copy link
Contributor

@RAMitchell RAMitchell commented Feb 17, 2022 •
edited
Loading

Goals:

  • Python documentation should be built for PRs
  • Checks should fail upon sphinx warnings
  • Existing warnings are fixed in this PR

This PR covers only the python documentation. C++ docs are out of scope.

@dantegd dantegd added improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Feb 17, 2022
@github-actions github-actions bot added the gpuCI gpuCI issue label Feb 18, 2022
@RAMitchell
Copy link
Contributor Author

Should now fail the CI build step.

@RAMitchell
Copy link
Contributor Author

CI fails as expected with python doc errors.

@github-actions github-actions bot added the Cython / Python Cython or Python issue label Feb 18, 2022
cjnolet
cjnolet approved these changes Feb 18, 2022
View reviewed changes
Copy link
Member

@cjnolet cjnolet left a comment

Choose a reason for hiding this comment

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

LGTM

@cjnolet
Copy link
Member

cjnolet commented Feb 19, 2022

rerun tests

1 similar comment
@RAMitchell
Copy link
Contributor Author

rerun tests

@RAMitchell RAMitchell marked this pull request as ready for review February 21, 2022 11:25
@RAMitchell RAMitchell requested review from a team as code owners February 21, 2022 11:25
ajschmidt8
ajschmidt8 approved these changes Feb 22, 2022
View reviewed changes
Copy link
Member

@ajschmidt8 ajschmidt8 left a comment

Choose a reason for hiding this comment

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

Approving ops-codeowner file changes

@dantegd
Copy link
Member

dantegd commented Feb 24, 2022

@gpucibot merge

@cjnolet
Copy link
Member

cjnolet commented Feb 24, 2022

rerun tests

1 similar comment
@dantegd
Copy link
Member

dantegd commented Mar 2, 2022

rerun tests

@dantegd dantegd mentioned this pull request Mar 7, 2022
Open
@dantegd
Copy link
Member

dantegd commented Mar 7, 2022

rerun tests

dantegd
dantegd requested changes Mar 7, 2022
View reviewed changes
ci/gpu/build.sh Outdated Show resolved Hide resolved
dantegd
dantegd approved these changes Mar 10, 2022
View reviewed changes
Copy link
Member

@dantegd dantegd left a comment

Choose a reason for hiding this comment

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

CI errors are unrelated to PR, so approving and will merge once CI is unblocked

@dantegd dantegd self-assigned this Mar 10, 2022
@dantegd
Copy link
Member

dantegd commented Mar 10, 2022

rerun tests

dantegd
dantegd requested changes Mar 14, 2022
View reviewed changes
ci/gpu/build.sh Outdated Show resolved Hide resolved
@RAMitchell
Copy link
Contributor Author

11th time is the charm.

@RAMitchell
Copy link
Contributor Author

Nope

@RAMitchell
Copy link
Contributor Author

rerun tests

1 similar comment
@RAMitchell
Copy link
Contributor Author

rerun tests

@dantegd
Copy link
Member

dantegd commented Mar 21, 2022

@RAMitchell #4637 will fix the current CI issue

@dantegd
Copy link
Member

dantegd commented Mar 24, 2022

rerun tests

@codecov-commenter
Copy link

Codecov Report

❗ No coverage uploaded for pull request base (branch-22.04@88ec85e). Click here to learn what that means.
The diff coverage is n/a.

@@               Coverage Diff               @@
##             branch-22.04    #4585   +/-   ##
===============================================
  Coverage                ?   83.86%           
===============================================
  Files                   ?      251           
  Lines                   ?    20307           
  Branches                ?        0           
===============================================
  Hits                    ?    17030           
  Misses                  ?     3277           
  Partials                ?        0
Flag Coverage Δ
dask 44.89% <0.00%> (?)
non-dask 77.03% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 88ec85e...fddc5e8. Read the comment docs.

@rapids-bot rapids-bot bot merged commit 3798925 into rapidsai:branch-22.04 Mar 28, 2022
vimarsh6739 pushed a commit to vimarsh6739/cuml that referenced this pull request Oct 9, 2023
@RAMitchell
Sphinx warnings as errors (rapidsai#4585)
8f30123 
Goals:
- Python documentation should be built for PRs 
- Checks should fail upon sphinx warnings
- Existing warnings are fixed in this PR

This PR covers only the python documentation. C++ docs are out of scope.

Authors:
  - Rory Mitchell (https://github.com/RAMitchell)
  - Dante Gama Dessavre (https://github.com/dantegd)

Approvers:
  - Corey J. Nolet (https://github.com/cjnolet)
  - AJ Schmidt (https://github.com/ajschmidt8)
  - Dante Gama Dessavre (https://github.com/dantegd)

URL: rapidsai#4585
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ajschmidt8 ajschmidt8 ajschmidt8 approved these changes

@cjnolet cjnolet cjnolet approved these changes

@dantegd dantegd dantegd approved these changes

Assignees

@dantegd dantegd

Labels
Cython / Python Cython or Python issue gpuCI gpuCI issue improvement Improvement / enhancement to an existing function non-breaking Non-breaking change
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@RAMitchell @cjnolet @dantegd @codecov-commenter @ajschmidt8