Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run Sphinx generation in Python 3. #26574

Merged
merged 8 commits into from
Nov 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@
('py:exc', 'BadOperationException'),
('py:exc', 'Exception'),
('py:exc', 'ValueError'),
('py:class', 'http.client.HTTPMessage')
]

# The language for content autogenerated by Sphinx. Refer to documentation
Expand Down Expand Up @@ -211,5 +212,5 @@ def setup(app):
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']

intersphinx_mapping = {'python': ('https://docs.python.org/2/', None),
intersphinx_mapping = {'python': ('https://docs.python.org/3/', None),
'mozilla': ('https://firefox-source-docs.mozilla.org/', None)}
4 changes: 2 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
recommonmark==0.6.0
# pin this to the last Py2 release
Sphinx==1.8.5 # pyup: <2.0
# Pin this to the same major version as https://docs.python.org/3/
Sphinx==2.4.4 # pyup: <3.0
sphinx-argparse==0.2.5
2 changes: 1 addition & 1 deletion docs/reviewing-tests/checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ tests; in case of any contradiction with requirements stated elsewhere in the
documentation it should be ignored
(please [file a bug](https://github.com/web-platform-tests/wpt/issues/new)!).

As noted on the [reviewing tests](index) page, nits need not block PRs
As noted on the [reviewing tests](./index.md) page, nits need not block PRs
from landing.


Expand Down
3 changes: 2 additions & 1 deletion docs/wpt_lint_rules.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
from recommonmark.parser import CommonMarkParser
import importlib
import textwrap
from six import iteritems

class WPTLintRules(Directive):
"""A docutils directive to generate documentation for the
Expand Down Expand Up @@ -31,7 +32,7 @@ def _get_rules(self):
"""wpt-lint-rules: unable to resolve the module at "{}".""".format(self.module_specifier)
)

for binding_name, value in module.__dict__.iteritems():
for binding_name, value in iteritems(module.__dict__):
if hasattr(value, "__abstractmethods__") and len(value.__abstractmethods__):
continue

Expand Down
4 changes: 2 additions & 2 deletions tools/docker/documentation/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
FROM python:2-stretch
FROM python:3.8-buster

RUN apt-get update && apt-get install --yes git
RUN apt-get update && apt-get install --yes git virtualenv
2 changes: 1 addition & 1 deletion tools/third_party/pywebsocket3/mod_pywebsocket/stream.py
Original file line number Diff line number Diff line change
Expand Up @@ -875,7 +875,7 @@ def close_connection(self,
wait_response: True when caller want to wait the response.
Raises:
BadOperationException: when reason is specified with code None
or reason is not an instance of both str and unicode.
or reason is not an instance of both str and unicode.
ziransun marked this conversation as resolved.
Show resolved Hide resolved
"""

if self._request.server_terminated:
Expand Down