-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Allow options to contain multiple words
When documenting subcommands, sometimes mkdocs-click will only show the subcommand name. `:prog_name:` seems to be the right option to ensure the actuall command is shown, but due to an overly-strict regex, it used to ignore everything after the first whitespace. With this change, `prog_name` and other commands can contain multiple words in their values. For example ``` ::: mkdocs-click :module: foo.utils.bridge :prog_name: foo-utils bridge :command: cli ``` now properly renders as > foo-utils bridge [OPTIONS] instead of > foo-utils [OPTIONS] or > bridge [OPTIONS] (^^ if prog_name wasn't specified at all) Co-Authored-By: Bar Hochman <bhochman@paloaltonetworks.com> Fixes #42
- Loading branch information
Hashem Nasarat
committed
Aug 31, 2022
1 parent
a8742d9
commit f8fc8e7
Showing
3 changed files
with
10 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters