NF: Consider warnings as errors in documentation CI build #933
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
skoudoro
reviewed
Aug 28, 2024
.github/workflows/doc.yml
Outdated
| @@ -46,7 +46,7 @@ jobs: | |||
| - name: Build docs | |||
| run: | | |||
| cd docs | |||
| make -C . html-no-examples | |||
| make -C . html-no-examples SPHINXOPTS="-W --keep-going -n" | |||
There was a problem hiding this comment.
the options -W --keep-going are ready to go and can be merged.
the option n generates 100 warnings treated as error. Some of them needs to be fixed and some of them needs to ignores using nitpick-ignore option: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpick_ignore
So I think, it should be split in 2 or more PRs
Also, we need
- a PR with
-b linkcheckoption and fix the broken link - a PR with numpydoc check activated
There was a problem hiding this comment.
@WassCodeur, Can you start creating a PR with -b linkcheck option?
Thank you
There was a problem hiding this comment.
@skoudoro Removed -n in the last commit; force pushed.
Consider warnings as errors in documentation CI build.
jhlegarreta
force-pushed
the
ConsiderDocWarningsAsErrors
branch
from
4328c50
to
6c19ac4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Consider warnings as errors in documentation CI build.