Add better doc support for multicommands.

Review Request #12133 — Created March 10, 2022 and submitted

Information

RBTools
master

Reviewers

The rbt-command-usage directive in our docs didn't handle the new
multi-commands very well (it would just print "rbt <subcommand>"). This
change extends it to rely on the commands' parser directly for
generating the help message, which improves the usage string, and adds a
list of available subcommands.

Built documentation and looked at the doc for rbt review.

Summary ID
Add better doc support for multicommands.
The `rbt-command-usage` directive in our docs didn't handle the new multi-commands very well (it would just print "rbt <subcommand>"). This change extends it to rely on the commands' parser directly for generating the help message, which improves the usage string, and adds a list of available subcommands. Testing Done: Built documentation and looked at the doc for `rbt review`.
43b1fa0cb3a867de472602ce9a3a939cbe5f2f6c

Description From Last Updated

I'm curious what this looks like. Can you put up a screenshot or something with an example of the new …

chipx86chipx86

Can you alphabetize these?

chipx86chipx86
chipx86
  1. 
      
  2. I'm curious what this looks like. Can you put up a screenshot or something with an example of the new docs?

  3. docs/rbtools/_ext/rbt_commands.py (Diff revision 1)
     
     

    Can you alphabetize these?

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

Status: Closed (submitted)

Change Summary:

Pushed to release-3.x (a495cf5)
Loading...