Do not treat doc warnings as errors #1134
Merged
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
nikhilwoodruff
approved these changes
Jul 15, 2022
sandcha
approved these changes
Jul 15, 2022
|
Thanks to you two! |
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.
This changeset stops documentation compilation warnings from being treated as errors.
An untreatable warning appeared in the codebase since an update to Sphinx (the engine building the doc):
<unknown>:1: WARNING: py:obj reference target not found: openfisca_core.types.data_types.arrays.T. Warnings are currently treated as errors when building the doc, meaning that the doc test always fails. For example, this failing CI is now blocking a PR as trivial as #1132.Applying this changeset implies that additional, legitimate warnings will not be made easily visible in CI. This is however the only way I found after a lot of investigation to solve this situation. See openfisca/openfisca-doc#264 (comment).