Add full subcommand support in the RBTools command docs extension.

Review Request #12190 — Created March 21, 2022 and submitted

chipx86
RBTools
release-3.x
rbtools

This introduces new directives for RBTools documentation that deals with
multi-commands:

  • rbt-subcommand
  • rbt-subcommand-usage
  • rbt-subcommand-options

This works just like the normal command equivalents, but are used to
document subcommands within a command.

Where possible, most of the code is shared between the command and
subcommand versions.

Upcoming changes will begin making use of these new directives.

Built new docs using these commands. Verified that the results were
correct, sections were in the right place (for both commands and
subcommands), and that references were all correct.

Summary
Add full subcommand support in the RBTools command docs extension.
Description From Last Updated

F841 local variable 'subcommand' is assigned to but never used

reviewbotreviewbot

E128 continuation line under-indented for visual indent

reviewbotreviewbot

E501 line too long (83 > 79 characters)

reviewbotreviewbot
Checks run (1 failed, 1 succeeded)
flake8 failed.
JSHint passed.

flake8

chipx86
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-3.x (624a057)
Loading...