Summary

Add full subcommand support in the RBTools command docs extension.

Review Request #12190 — Created March 21, 2022 and submitted March 21, 2022, 10:20 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-3.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

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.

Testing Done

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.

Commits

Summary	ID
Add full subcommand support in the RBTools command docs extension. 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.	25a8cfa45307f4bd69585022cbf450d55f8c67fc

Summary

Add full subcommand support in the RBTools command docs extension.

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.

25a8cfa45307f4bd69585022cbf450d55f8c67fc

Issues

Description	From	Last Updated
F841 local variable 'subcommand' is assigned to but never used	reviewbot	March 21, 2022, 9:56 p.m.
E128 continuation line under-indented for visual indent	reviewbot	March 21, 2022, 9:56 p.m.
E501 line too long (83 > 79 characters)	reviewbot	March 21, 2022, 9:56 p.m.

flake8 failed.

JSHint passed.

flake8

docs/rbtools/_ext/rbt_commands.py (Diff revision 1)
The issue has been resolved. Show all issues
```
F841 local variable 'subcommand' is assigned to but never used
```
docs/rbtools/_ext/rbt_commands.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E128 continuation line under-indented for visual indent
```
docs/rbtools/_ext/rbt_commands.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E501 line too long (83 > 79 characters)
```

Change Summary:


Fixed some indentation/line length issues from a search-and-replace.
Removed an unused variable.

Commits:

	Summary	ID
	Add full subcommand support in the RBTools command docs extension. 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.	a4223fee03465060073d8339ce3fd3c1bf246282
	Add full subcommand support in the RBTools command docs extension. 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.	25a8cfa45307f4bd69585022cbf450d55f8c67fc

Diff:

Revision 2 (+706 -52)

Show changes

	docs/rbtools/_ext/rbt_commands.py
	rbtools/commands/__init__.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-3.x (624a057)