Fix doc build warning misattributions by upgrading Sphinx#1745
Merged
einarf merged 1 commit intopythonarcade:developmentfrom May 5, 2023
Merged
Fix doc build warning misattributions by upgrading Sphinx#1745einarf merged 1 commit intopythonarcade:developmentfrom
einarf merged 1 commit intopythonarcade:developmentfrom
Conversation
cspotcode
approved these changes
May 4, 2023
Member
|
Let's just mere this. |
This file contains hidden or 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
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.
Changes
pyproject.tomlWhy
tl;dr
sphinx==6.2.1fixes this issue6.2.1is the last version before7.0.0makes breaking changesBefore upgrading Sphinx
This is the error output received in our CI:
However, there is no block quote in the top level docstring.
After upgrading Sphinx
Upgrading makes the location of the issue more legible:
At first glance, there doesn't seem to be anything immediately wrong. However, closer inspection allows us to understand it's the unescaped
\n.