Skip to content

Commit 851d1b7

Browse files
committed
markdown: do not generate docs for hidden commands
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
1 parent f0e625f commit 851d1b7

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

clidocstool_md.go

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,12 @@ func (c *Client) GenMarkdownTree(cmd *cobra.Command) error {
5353
return nil
5454
}
5555

56+
// Skip hidden command
57+
if cmd.Hidden {
58+
log.Printf("INFO: Skipping Markdown for %q (hidden command)", cmd.CommandPath())
59+
return nil
60+
}
61+
5662
log.Printf("INFO: Generating Markdown for %q", cmd.CommandPath())
5763
mdFile := mdFilename(cmd)
5864
sourcePath := filepath.Join(c.source, mdFile)
@@ -208,6 +214,9 @@ func mdCmdOutput(cmd *cobra.Command, old string) (string, error) {
208214
b.WriteString("### Subcommands\n\n")
209215
table := newMdTable("Name", "Description")
210216
for _, c := range cmd.Commands() {
217+
if c.Hidden {
218+
continue
219+
}
211220
table.AddRow(fmt.Sprintf("[`%s`](%s)", c.Name(), mdFilename(c)), c.Short)
212221
}
213222
b.WriteString(table.String() + "\n")

0 commit comments

Comments
 (0)