Fail on Docutils warning #2288
Merged
Fail on Docutils warning #2288
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
|
Response to your comment on #2285 ; moved here to avoid derailing that PR further.
Yup, I upgraded to 4.4.0 and see the errors now.
Doesn't appear to be fixed at least from my testing; I rebased bd3275f on the latest Full output in case its useful: $ python -b -X dev build.py -n
Running Sphinx v4.4.0
loading pickled environment... done
building [html]: targets for 2 source files that are out of date
updating environment: 0 added, 2 changed, 0 removed
reading sources... [100%] pep-0681
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0681.rst:422: ERROR: Unexpected indentation.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0681.rst:422: WARNING: Inline emphasis start-string without end-string.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0681.rst:426: WARNING: Block quote ends without a blank line; unexpected unindent.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0681.rst:430: ERROR: Unexpected indentation.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0681.rst:430: WARNING: Inline emphasis start-string without end-string.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0681.rst:434: WARNING: Block quote ends without a blank line; unexpected unindent.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0681.rst:440: WARNING: Inline emphasis start-string without end-string.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0681.rst:442: WARNING: Definition list ends without a blank line; unexpected unindent.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0681.rst:448: ERROR: Unexpected indentation.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0681.rst:532: ERROR: Unexpected indentation.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0681.rst:530: WARNING: Inline literal start-string without end-string.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0681.rst:704: ERROR: Indirect hyperlink target "pyright discussion" refers to target "#converters", which does not exist.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0681.rst:704: ERROR: Unknown target name: "#converters".
looking for now-outdated files... none found
pickling environment... done
checking consistency... C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\docs\build.rst: WARNING: document isn't included in any toctree
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\docs\rendering_system.rst: WARNING: document isn't included in any toctree
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0484.txt:2490: WARNING: Citation [peps] is not referenced.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0520.txt:416: WARNING: Citation [nick_concern] is not referenced.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0520.txt:419: WARNING: Citation [orig] is not referenced.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0520.txt:422: WARNING: Citation [followup1] is not referenced.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0520.txt:425: WARNING: Citation [followup2] is not referenced.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0553.rst:283: WARNING: Citation [envar] is not referenced.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0554.rst:1645: WARNING: Citation [CSP] is not referenced.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0554.rst:1677: WARNING: Citation [mp-conn] is not referenced.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0554.rst:1686: WARNING: Citation [main-thread] is not referenced.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0554.rst:1709: WARNING: Citation [nathaniel-asyncio] is not referenced.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0554.rst:1712: WARNING: Citation [extension-docs] is not referenced.
C:\Users\C. A. M. Gerlach\Documents\dev\SpyderDev\other_repos\peps\pep-0593.rst:265: WARNING: Citation [struct-doc] is not referenced.
done
preparing documents... done
writing output... [100%] pep-0681
generating indices... done
writing additional pages... done
copying static files... done
copying extra files... done
dumping object inventory... done
build succeeded, 27 warnings.
The HTML pages are in build.
$ echo $?
0 |
|
A very quick check on CI (branch https://github.com/AA-Turner/peps/tree/test-bad-commit, run https://github.com/AA-Turner/peps/runs/4987962794) errors out. The interesting bit is why your system doesn't fail locally. Can you try shift-deleting the A |
|
For comparison, output with (nearly) the same command. Note the failure happened as soon as 681 was read, and during the read stage. A |
|
Tried with |
|
Welp, you were spot on—I |
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.
Fail the build on warnings or above from the Docutils reporter.
Prompted by Cam in #2285 (comment)
A