Skip to content

Do not generate reference docs from the plugin #2322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gr0 merged 1 commit into from
Aug 7, 2025
Merged

Do not generate reference docs from the plugin #2322

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions app/cli/documentation/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ func main() {

var builder strings.Builder
for _, subCmd := range command.Commands() {
if !subCmd.Hidden {
if !subCmd.Hidden && !isPluginCommand(subCmd) {
// Start depth at 0 for subcommands
generateCommandDocs(subCmd, &builder, 0)
}
Expand All @@ -82,7 +82,7 @@ func generateCommandDocs(cmd *cobra.Command, builder *strings.Builder, currentDe

// Recursively process subcommands with increased depth
for _, subCmd := range cmd.Commands() {
if !subCmd.Hidden {
if !subCmd.Hidden && !isPluginCommand(subCmd) {
generateCommandDocs(subCmd, builder, currentDepth+1)
}
}
Expand Down Expand Up @@ -148,6 +148,11 @@ func isUnderlineHeader(line string) bool {
return regexp.MustCompile(`^[-=]+$`).MatchString(line)
}

// isPluginCommand checks if a command is from a plugin by looking for the plugin signature in the Long description
func isPluginCommand(cmd *cobra.Command) bool {
return strings.Contains(cmd.Long, "Provided by plugin:")
}

// processFinalDocument cleans up the final document by removing excessive newlines and headers.
func processFinalDocument(content string) string {
// Clean up excessive newlines and leftover headers
Expand Down
Loading