1742605 - [wpt-sync] Sync PR 31440 - Use JSDoc for documentation

Status: RESOLVED FIXED

(Testing :: web-platform-tests, task, P4)

Description

[Web Platform Test Sync Bot (Matrix: #interop:mozilla.org)]

Sync web-platform-tests PR 31440 into mozilla-central (this bug is closed when the sync is complete).

PR: https://github.com/web-platform-tests/wpt/pull/31440
Details from upstream follow.

James Graham <[e-mail]> wrote:

Use JSDoc for documentation

The goal here is to address some complaints around the quality of the API documentation, and to make the docs easier to maintain going forward. To that end there are two big changes:

• The addition of sphinx-js to enable adding JSDoc strings directly into the docs.
• Conversion of the testharness and testdriver docs to use the JSDoc rather than repeating all the documentation in the markdown files as well as in the source.

There are also some incidential changes:

• The readdition of a Dockerfile for generating docs. The wpt build-docs command is updated to optionally use this docker image, avoiding the need to install the js components locally.
• The addition of sphinx-autoreload so that it's possible to work on the docs using a local server and have the output regenerated when the inputs change.

Comment 1

[Web Platform Test Sync Bot (Matrix: #interop:mozilla.org)]

PR 31440 applied with additional changes from upstream: ae483100a12ee8e7110c95142f95b14f2d659f6a

Comment 2

[Web Platform Test Sync Bot (Matrix: #interop:mozilla.org)]

Pushed to try https://treeherder.mozilla.org/#/jobs?repo=try&revision=26cefc2d90e2d6d8c630062741c5591e5c436be8

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/3b847659e868
[wpt PR 31440] - Use JSDoc for documentation, a=testonly

Comment 4

[Web Platform Test Sync Bot (Matrix: #interop:mozilla.org)]

Test result changes from PR not available.

Comment 5

[Iulian Moraru]

https://hg.mozilla.org/mozilla-central/rev/3b847659e868