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

CI: Force docs warnings to be raised as errors (+ fix all) #1191

Merged
merged 52 commits into from
Mar 20, 2020
Merged

CI: Force docs warnings to be raised as errors (+ fix all) #1191

merged 52 commits into from
Mar 20, 2020

Conversation

awaelchli
Copy link
Contributor

@awaelchli awaelchli commented Mar 18, 2020 •
edited
Loading

Before submitting

  • Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure to update the docs?
  • Did you write any new necessary tests?
  • If you made a notable change (that affects users), did you update the CHANGELOG?

What does this PR do?

Fixes #1183

  • This PR raises all docs build warnings as errors. They are now visible in CI.
  • Fixed 100+ docs warnings fixed
  • In the future, docs will break less often because CI will throw the errors.

@Borda Borda added docs Documentation related feature Is an improvement or enhancement ci Continuous Integration labels Mar 18, 2020
@Borda Borda self-requested a review March 18, 2020 22:24
@Lightning-AI Lightning-AI deleted a comment from awaelchli Mar 18, 2020
@pep8speaks
Copy link

pep8speaks commented Mar 18, 2020 •
edited
Loading

Hello @awaelchli! Thanks for updating this PR.

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2020-03-20 12:55:54 UTC

@codecov
Copy link

codecov bot commented Mar 19, 2020 •
edited
Loading

Codecov Report

Merging #1191 into master will not change coverage by %.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #1191   +/-   ##
======================================
  Coverage      91%     91%           
======================================
  Files          62      62           
  Lines        3120    3120           
======================================
  Hits         2829    2829           
  Misses        291     291

@awaelchli
Copy link
Contributor Author

awaelchli commented Mar 20, 2020 •
edited
Loading

@Borda I have reduced 100+ errors and warnings to now only 3 that I am stuck with. Maybe you see a good fix for some of them?

@awaelchli awaelchli changed the title WIP Docs warn CI: Force docs warnings to be raised as errors (+ fix all) Mar 20, 2020
@awaelchli awaelchli marked this pull request as ready for review March 20, 2020 05:51
@Borda
Copy link
Member

Borda commented Mar 20, 2020

@Borda I have reduced 100+ errors and warnings to now only 3 that I am stuck with. Maybe you see a good fix for some of them?

That's SUPER COOL!

Borda
Borda approved these changes Mar 20, 2020
View reviewed changes
Copy link
Member

@Borda Borda left a comment

Choose a reason for hiding this comment

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

Awesome! just consider add a note to CHAGELOG 🚀

docs/source/tutorials.rst Show resolved Hide resolved
@Borda Borda added the ready PRs ready to be merged label Mar 20, 2020
@Borda Borda added this to the 0.7.2 milestone Mar 20, 2020
Adrian Wälchli added 2 commits March 20, 2020 13:00
@Borda
Copy link
Member

Borda commented Mar 20, 2020 via email

@awaelchli
Copy link
Contributor Author

not true, as the name states it is required while installing the package...

yes you are right, otherwise install breaks.

tullie
tullie approved these changes Mar 20, 2020
View reviewed changes
Copy link
Contributor

@tullie tullie left a comment

Choose a reason for hiding this comment

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

lgtm

@Borda Borda merged commit 792962e into Lightning-AI:master Mar 20, 2020
@awaelchli awaelchli deleted the docs-warn branch April 1, 2020 02:49
@Borda Borda modified the milestones: v0.7., v0.7.x Apr 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Borda Borda Borda approved these changes

@neggert neggert neggert approved these changes

@tullie tullie tullie approved these changes

Assignees

@awaelchli awaelchli

Labels
ci Continuous Integration docs Documentation related feature Is an improvement or enhancement ready PRs ready to be merged
Projects
None yet
Milestone
pl:0.7.x
Development

Successfully merging this pull request may close these issues.

CI: Force docs compilation warnings to be raised as errors
5 participants
@awaelchli @pep8speaks @Borda @neggert @tullie