Add full subcommand support in the RBTools command docs extension.

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

Information

RBTools
release-3.x

Reviewers

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.

Diff Revision 2 (Latest)

orig
1
2

Commits

First Last Summary ID Author
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 Christian Hammond
docs/rbtools/_ext/rbt_commands.py
rbtools/commands/__init__.py
Loading...