fix gen-doc to deal with hidden commands (#572)

Author: tclemos

doc/polycli_ulxly_bridge.md

@@ -51,10 +51,9 @@ The command also inherits flags from parent commands.
 
 ## See also
 
-- [polycli ulxly ](polycli_ulxly_.md) - 
-- [polycli ulxly  bridge asset](polycli_ulxly__bridge_asset.md) - Move ETH or an ERC20 between to chains
+- [polycli ulxly bridge asset](polycli_ulxly_bridge_asset.md) - Move ETH or an ERC20 between to chains
 
-- [polycli ulxly  bridge message](polycli_ulxly__bridge_message.md) - Send some ETH along with data from one chain to another chain
+- [polycli ulxly bridge message](polycli_ulxly_bridge_message.md) - Send some ETH along with data from one chain to another chain
 
-- [polycli ulxly  bridge weth](polycli_ulxly__bridge_weth.md) - For L2's that use a gas token, use this to transfer WETH to another chain
+- [polycli ulxly bridge weth](polycli_ulxly_bridge_weth.md) - For L2's that use a gas token, use this to transfer WETH to another chain
 

doc/polycli_ulxly_bridge_asset.md

@@ -127,4 +127,4 @@ The command also inherits flags from parent commands.
 
 ## See also
 
-- [polycli ulxly  bridge](polycli_ulxly__bridge.md) - Commands for moving funds and sending messages from one chain to another
+- [polycli ulxly bridge](polycli_ulxly_bridge.md) - Commands for moving funds and sending messages from one chain to another

doc/polycli_ulxly_bridge_message.md

@@ -124,4 +124,4 @@ The command also inherits flags from parent commands.
 
 ## See also
 
-- [polycli ulxly  bridge](polycli_ulxly__bridge.md) - Commands for moving funds and sending messages from one chain to another
+- [polycli ulxly bridge](polycli_ulxly_bridge.md) - Commands for moving funds and sending messages from one chain to another

doc/polycli_ulxly_bridge_weth.md

@@ -93,4 +93,4 @@ The command also inherits flags from parent commands.
 
 ## See also
 
-- [polycli ulxly  bridge](polycli_ulxly__bridge.md) - Commands for moving funds and sending messages from one chain to another
+- [polycli ulxly bridge](polycli_ulxly_bridge.md) - Commands for moving funds and sending messages from one chain to another

doc/polycli_ulxly_claim-everything.md

@@ -7,7 +7,6 @@
 - [Description](#description)
 - [Usage](#usage)
 - [Flags](#flags)
-- [See Also](#see-also)
 
 ## Description
 
@@ -51,6 +50,3 @@ The command also inherits flags from parent commands.
                                            700 Trace (default 500)
 ```
 
-## See also
-
-- [polycli ulxly ](polycli_ulxly_.md) - 

doc/polycli_ulxly_claim.md

@@ -50,8 +50,7 @@ The command also inherits flags from parent commands.
 
 ## See also
 
-- [polycli ulxly ](polycli_ulxly_.md) - 
-- [polycli ulxly  claim asset](polycli_ulxly__claim_asset.md) - Claim a deposit
+- [polycli ulxly claim asset](polycli_ulxly_claim_asset.md) - Claim a deposit
 
-- [polycli ulxly  claim message](polycli_ulxly__claim_message.md) - Claim a message
+- [polycli ulxly claim message](polycli_ulxly_claim_message.md) - Claim a message
 

doc/polycli_ulxly_claim_asset.md

@@ -136,4 +136,4 @@ The command also inherits flags from parent commands.
 
 ## See also
 
-- [polycli ulxly  claim](polycli_ulxly__claim.md) - Commands for claiming deposits on a particular chain
+- [polycli ulxly claim](polycli_ulxly_claim.md) - Commands for claiming deposits on a particular chain

doc/polycli_ulxly_claim_message.md

@@ -141,4 +141,4 @@ The command also inherits flags from parent commands.
 
 ## See also
 
-- [polycli ulxly  claim](polycli_ulxly__claim.md) - Commands for claiming deposits on a particular chain
+- [polycli ulxly claim](polycli_ulxly_claim.md) - Commands for claiming deposits on a particular chain

docutil/doc.go

@@ -26,10 +26,7 @@ func genMarkdownDoc(cmd *cobra.Command, dir string) error {
 	}
 
 	basename := strings.ReplaceAll(cmd.CommandPath(), " ", "_") + ".md"
-	// clean dupped underscores
-	for strings.Contains(basename, "__") {
-		basename = strings.ReplaceAll(basename, "__", "_")
-	}
+	basename = cleanDuppedSeparator(basename, "_")
 	filename := filepath.Join(dir, basename)
 	f, err := os.Create(filename)
 	if err != nil {
@@ -139,7 +136,7 @@ func printFlags(buf *bytes.Buffer, cmd *cobra.Command, name string) error {
 // both not deprecated and not the autogenerated help command.
 // This is a fork of Cobra's `hasSeeAlso` function.
 func hasSeeAlso(cmd *cobra.Command) bool {
-	if cmd.HasParent() {
+	if cmd.HasParent() && cmd.Parent().IsAvailableCommand() && !cmd.Parent().IsAdditionalHelpTopicCommand() {
 		return true
 	}
 	for _, c := range cmd.Commands() {
@@ -153,11 +150,14 @@ func hasSeeAlso(cmd *cobra.Command) bool {
 
 // Print See Also section.
 func printSeeAlso(buf *bytes.Buffer, cmd *cobra.Command, name string, linkHandler func(s string) string) {
-	if cmd.HasParent() {
+	if cmd.HasParent() && cmd.Parent().IsAvailableCommand() && !cmd.Parent().IsAdditionalHelpTopicCommand() {
 		parent := cmd.Parent()
 		pname := parent.CommandPath()
+		pname = cleanDuppedSeparator(pname, " ")
+		pname = strings.TrimSuffix(pname, " ")
 		link := pname + ".md"
 		link = strings.Replace(link, " ", "_", -1)
+		link = cleanDuppedSeparator(link, "_")
 		buf.WriteString(fmt.Sprintf("\n- [%s](%s) - %s", pname, linkHandler(link), parent.Short))
 		cmd.VisitParents(func(c *cobra.Command) {
 			if c.DisableAutoGenTag {
@@ -174,8 +174,11 @@ func printSeeAlso(buf *bytes.Buffer, cmd *cobra.Command, name string, linkHandle
 			continue
 		}
 		cname := name + " " + child.Name()
+		cname = cleanDuppedSeparator(cname, " ")
+		cname = strings.TrimSuffix(cname, " ")
 		link := cname + ".md"
 		link = strings.Replace(link, " ", "_", -1)
+		link = cleanDuppedSeparator(link, "_")
 		buf.WriteString(fmt.Sprintf("\n- [%s](%s) - %s\n", cname, linkHandler(link), child.Short))
 	}
 	buf.WriteString("\n")
@@ -186,3 +189,11 @@ type byName []*cobra.Command
 func (s byName) Len() int           { return len(s) }
 func (s byName) Swap(i, j int)      { s[i], s[j] = s[j], s[i] }
 func (s byName) Less(i, j int) bool { return s[i].Name() < s[j].Name() }
+
+func cleanDuppedSeparator(s string, sep string) string {
+	// clean dupped separators
+	for strings.Contains(s, sep+sep) {
+		s = strings.ReplaceAll(s, sep+sep, sep)
+	}
+	return s
+}