You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We use Sphinx to parse arguments from a few wpt commands and generate docs automatically. It's currently running in Python 2. This is a reminder that once we switch our primary supported version to Python 3, we should upgrade Sphinx and run it with Python 3.
The text was updated successfully, but these errors were encountered:
@ziransun - can you start looking at how compatible our document generation is with Py3? (Low priority, but since the RFC is ongoing).
I believe wpt build-docs will run it, but you'll need to make sure that it's actually using py3 all the way down. Very high level list of things I think will likely need to happen:
Make sure that Python3 is being used all the way down when running wpt build-docs.
Update to a new Sphinx version (in docs/requirements.txt) that supports py3
Figure out any problems, iterate on fixing them :)
Eventually update the docker image used for this (see tools/docker/documentation/Dockerfile) to be py3 based, though this shouldn't be required for local testing.
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
We use Sphinx to parse arguments from a few
wpt
commands and generate docs automatically. It's currently running in Python 2. This is a reminder that once we switch our primary supported version to Python 3, we should upgrade Sphinx and run it with Python 3.The text was updated successfully, but these errors were encountered: