mirrors/gecko-dev
1
0
Fork 1
mirror of https://github.com/mozilla/gecko-dev.git synced 2025-11-12 06:08:24 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
gecko-dev/testing/web-platform/tests/docs/running-tests/command-line-arguments.md
jugglinmike a65d508901 Bug 1554416 [wpt PR 16851] - [docs] Automatically generate CLI documentation, a=testonly 
Automatic update from web-platform-tests
[docs] Automatically generate CLI documentation (#16851)

Command-line usage information was previously only available to users
who had successfully installed wptrunner. Consuming the information in
that form (e.g. navigating between sub-commands, scrolling through pages
of content and searching for keywords) also required some proficiency
with the command-line.

Extend the documentation build process to include this information in
the project website. This makes it easier to consume for those with
limited experience using the command-line, and in particular, it adds
the content to the data indexed by the website's "search" feature.

Because this content is generated from the state of the interface, it
avoids the need to maintain documentation separately.

This is implemented via a new code path that eagerly load wptrunner's
complete command-line interface. The new `create_complete_parser` is
consumed by the `sphinx-argparse` module to produce the rendered
documentation.
--

wp5At-commits: 3149a4323132331e0179d85fdcf35b13c5df9f2f
wpt-pr: 16851
2019-06-19 11:06:01 -07:00

412 B
Raw Blame History

Command-Line Arguments

The wpt command-line application offers a number of features for interacting with WPT. The functionality is organized into "sub-commands", and each accepts a different set of command-line arguments.

This page documents all of the available sub-commands and associated arguments.

.. argparse::
   :module: tools.wpt.wpt
   :func: create_complete_parser
   :prog: wpt