mirror of
https://github.com/HeyPuter/firefox.git
synced 2026-11-13 20:14:57 -10:00
James Graham
b00b9c8720
Automatic update from web-platform-tests Use wpt build-docs to actually build the docs This removes the previous Makefile, to simplify things by only having a single supported entrypoint and a single programming language for docs building. -- Use source-dir relative paths in toc includes -- Upgrade Sphinx to 3.x This is in preparation for adding sphinx-js, which seems to be tested with the 3.x branch of sphinx -- Add support for building js docs with sphinx-js This requires jsdoc to be installed using `npm install -g jsdoc`. -- Add a docker image for building docs This adds a docker container (which locally is tagged as wpt:docs) to enable building the documentation without installing system level dependencies. The `wpt build-docs` command is updated to allow running the build in the docker image using `./wpt build-docs --docker`. -- Add support for running a docs server with auto-reload. This adds a `--serve` option to `wpt build-docs` which will run a local server. sphinx-autobuild is used so that the docs are automatically rebuilt when relevant files change. -- Tests can't have a status of ERROR, so don't try to set that in assert_wrapper -- Rewrite testharness API docs This extracts more of the documentation from the JSDoc comments in the file itself and reorganises things a little so the documentation is easier to navigate. -- Rewrite the testdriver docs. This extracts most of the documentation from the JSDoc comments rather than maintaining it in two places. Due to the limitations of sphinx-js, it seems like every command needs to be included one-by-one in the docs. However that has the advantage that we can give them some orgnaisation rather than just providing a flat list of commands. -- Use repo from environment rather than hardcoding -- Add ToC to tutorial -- Update docs/writing-tests/testharness-api.md -- Update resources/testharness.js -- Use package.json to specify node deps -- Sort docs requirements -- Update links in testharness.js -- Update step_func documentation -- Fix some broken links -- Run npm install in the docs directory in CI Trying to run it in the parent seems to not work in npm 6.x -- Apply suggestions from code review Co-authored-by: Philip Jägenstedt <[email protected]> -- Fix documentation of Test.force_timeout I couldn't get sphinx-js to work with @name or @function, so it seems to be easier just to make an actual wrapper function so the docs render correctly. -- wpt-commits: a7c2f5336fc2498eb1357bc21df8b6054ccfc307, 7cf9683979a4469d9650f0a365f8deaeaec8fcaf, 1c980b87fe138e6d37c16e5ff7e766affcabfa4f, 3442f9298c2ca38909bf2a9498de83c92afce83c, d0abf20f5f2a32552d320c3aa23a0b322a7b793e, 2897f6deba92599d11b771573ac25815e7341d45, 03f2914e1ab8607a29c24d590208b5918f84e68c, 9bffa5e1c8f7a6491df9dfaa678bd082da0d3b88, 1e8f81eb898bceff04b1da1aa3a1a30c27b7ca80, 942abbefff3a88954b8ef797df75c78d404412fe, d7de25c4ac8a0185b2e8f39eb3a0e1c780b04e9c, 687889d139659431a7ad98d65d31b61277d08d5a, 55757e77fd8778119121499948d241c0e27c1be2, df23f9795f318e54e15909eb5253dc16e6354f88, cd8deaa9fe3b7787126a50db4e42d4d3c1d3e967, 45a541fd16a848ea50032eced45e67943caee158, 06ba907c8e98e700e3b6bfb9609c8e2d04c4df9f, 9ad5bc7b567c630039b7b18eb90f06de43ba4c78, d9c50083202144fba4a8a48bf169456d8db942b1, 2d72c918fb9c263d49d5666ff6dd692ae546d9bc, 2c2855cbf851eb114983c165fbeafc3bcf10e8bf wpt-pr: 31440
12 lines
245 B
JSON
12 lines
245 B
JSON
{
|
|
"name": "wpt-docs",
|
|
"description": "This package file is for node modules used in web-platform-tests docs",
|
|
"repository": {},
|
|
"license": "BSD",
|
|
"devDependencies": {
|
|
"jsdoc": "3.6.7"
|
|
},
|
|
"version": "1.0.0",
|
|
"private": true
|
|
}
|