зеркало из https://github.com/mozilla/gecko-dev.git
Bug 1560902 [wpt PR 17401] - [docs] Increase strictness of build process, a=testonly
Automatic update from web-platform-tests [docs] Increase strictness of build process (#17401) Use the `-W` flag to interpret Sphinx warnings as errors, causing the build to fail in the presence of either. This makes various authoring mistakes more visible. Perhaps most importantly: it highlights instances of "orphaned" content. Fix all details which were previously reported as warnings and thus permitted. -- wpt-commits: 9c6304b71c5ee090ebc1eef02ab32b70444d9704 wpt-pr: 17401
This commit is contained in:
jugglinmike
James Graham
Родитель
4a861cafd1
Коммит
98bcfce7bb
|
|
@ -2,7 +2,7 @@
|
|||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXOPTS = -W
|
||||
SPHINXBUILD = sphinx-build
|
||||
SOURCEDIR = .
|
||||
BUILDDIR = _build
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# WPT documentation
|
||||
# Project documentation tooling
|
||||
|
||||
The documentation for the web-platform-tests project is built using [the Sphinx
|
||||
documentation generator](http://www.sphinx-doc.org). [The GitHub Actions
|
||||
|
|
|
|||
|
|
@ -3,6 +3,15 @@
|
|||
This section documents all the information necessary to administer the
|
||||
infrastructure which makes the project possible.
|
||||
|
||||
## Tooling
|
||||
|
||||
```eval_rst
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
||||
../README
|
||||
```
|
||||
|
||||
## Secrets
|
||||
|
||||
Some aspects of the infrastructure are only accessible to administrators.
|
||||
|
|
|
|||
|
|
@ -11,7 +11,12 @@ delimit text to be replaced and `#` represents a digit.
|
|||
|
||||
### Test
|
||||
|
||||
``` html
|
||||
<!--
|
||||
Syntax highlighting cannot be enabled for the following template because it
|
||||
contains invalid CSS.
|
||||
-->
|
||||
|
||||
```
|
||||
<!DOCTYPE html>
|
||||
<meta charset="utf-8">
|
||||
<title>${1:Test title}</title>
|
||||
|
|
@ -28,7 +33,12 @@ Filename: `{test-topic}-###.html`
|
|||
|
||||
### Reference:
|
||||
|
||||
``` html
|
||||
<!--
|
||||
Syntax highlighting cannot be enabled for the following template because it
|
||||
contains invalid CSS.
|
||||
-->
|
||||
|
||||
```
|
||||
<!DOCTYPE html>
|
||||
<meta charset="utf-8">
|
||||
<title>${1:Reference title}</title>
|
||||
|
|
|
|||
|
|
@ -76,7 +76,7 @@ expectations:
|
|||
expected. They get their name from the JavaScript harness that's used to
|
||||
execute them.
|
||||
|
||||
* [wdspec]() tests are written in Python and test [the WebDriver browser
|
||||
* [wdspec][] tests are written in Python and test [the WebDriver browser
|
||||
automation protocol](https://w3c.github.io/webdriver/)
|
||||
|
||||
* [Manual tests][manual] rely on a human to run them and determine their
|
||||
|
|
|
|||
|
|
@ -115,6 +115,13 @@ customising the test run:
|
|||
[A complete listing of the command-line arguments is available
|
||||
here](command-line-arguments).
|
||||
|
||||
```eval_rst
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
command-line-arguments
|
||||
```
|
||||
|
||||
Additional browser-specific documentation:
|
||||
|
||||
```eval_rst
|
||||
|
|
|
|||
|
|
@ -179,11 +179,13 @@ class Response(object):
|
|||
If any part of the content is a function, this will be called
|
||||
and the resulting value (if any) returned.
|
||||
|
||||
:param read_file: - boolean controlling the behaviour when content
|
||||
is a file handle. When set to False the handle will be returned directly
|
||||
allowing the file to be passed to the output in small chunks. When set to
|
||||
True, the entire content of the file will be returned as a string facilitating
|
||||
non-streaming operations like template substitution.
|
||||
:param read_file: boolean controlling the behaviour when content is a
|
||||
file handle. When set to False the handle will be
|
||||
returned directly allowing the file to be passed to
|
||||
the output in small chunks. When set to True, the
|
||||
entire content of the file will be returned as a
|
||||
string facilitating non-streaming operations like
|
||||
template substitution.
|
||||
"""
|
||||
if isinstance(self.content, binary_type):
|
||||
yield self.content
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче