Run Sphinx generation in Python 3. #26574
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
Issue web-platform-tests#23081 This CL made the following changes: [1] Upgrading Sphinx version to 3.3.1 to support python 3.5+ [2] Fixing bugs invoked during Py3 run. a) Replace reference of "index" in checklist.md with relative path for index.md. This is due to "more than one target found for cross-reference" error thrown by Sphinx referring to it. It's a known issue in sphinx (sphinx-doc/sphinx#2549) b) Fix Sphinx in third_party/pywebsocket3. A PR has been sent at GoogleChromeLabs/pywebsocket3#16 Note: Command to run with Python3 is: wpt --py3 build-docs
wpt-pr-bot
requested review from
Hexcles,
LukeZielinski,
sideshowbarker and
stephenmcgruer
|
The job failed on GitHub Actions: https://github.com/web-platform-tests/wpt/pull/26574/checks?check_run_id=1424211186#step:3:414 Looks like we don't have virtualenv in Docker? The change looks sane to me. I'm not sure why it worked before but not now; I suspect it's the difference between the base images ( |
Hexcles
reviewed
Nov 19, 2020
Hexcles
reviewed
Nov 24, 2020
Hexcles
reviewed
Nov 25, 2020
docs/requirements.txt
Outdated
| @@ -1,4 +1,4 @@ | |||
| recommonmark==0.6.0 | |||
| # pin this to the last Py2 release | |||
| Sphinx==1.8.5 # pyup: <2.0 | |||
| Sphinx==3.3.1 # pyup: <2.0 | |||
There was a problem hiding this comment.
Suggested change
| Sphinx==3.3.1 # pyup: <2.0 | |
| Sphinx==2.4.4 # pyup: <3.0 |
|
@Hexcles: Code updated. Thank you! |
Co-authored-by: Robert Ma <bob1211@gmail.com>
jgraham
requested changes
Nov 26, 2020
Hexcles
reviewed
Nov 26, 2020
Hexcles
reviewed
Nov 26, 2020
Hexcles
approved these changes
Nov 26, 2020
|
@jgraham PTAL again. Also, WDYT about the pywebsocket3 change? This is the only change since our latest roll. I'm happy to do a |
jgraham
approved these changes
Nov 26, 2020
Hexcles
added a commit
that referenced
this pull request
Dec 14, 2020
1. Mark the command as py3only (since #26574). 2. Skip .tox, and fix other exclude patterns.
Merged
Hexcles
added a commit
that referenced
this pull request
Dec 15, 2020
1. Mark the command as py3only (since #26574). 2. Skip .tox, and fix other exclude patterns.
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.
Issue #23081
This CL made the following changes:
[1] Upgrading Sphinx version to 3.3.1 to support python 3.5+
[2] Fixing bugs invoked during Py3 run.
a) Replace reference of "index" in checklist.md with relative path for
index.md. This is due to "more than one target found for cross-reference"
error thrown by Sphinx referring to it. It's a known issue in
sphinx (sphinx-doc/sphinx#2549)
b) Fix Sphinx in third_party/pywebsocket3. A PR has been sent at
GoogleChromeLabs/pywebsocket3#16
Note: Command to run with Python3 is: wpt --py3 build-docs