glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2024-11-24 14:47:12 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #228 from garthk/fix-doc-generation

Browse source 
Fix doc generation and its documentation
This commit is contained in:
Eric Paris 2016-01-16 22:09:38 -05:00
commit 8e91712f17
4 changed files with 37 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/man_docs.go
View file

@ -18,6 +18,7 @@ import (
"fmt"
"io"
"os"
"path/filepath"
"sort"
"strings"
"time"
@ -46,8 +47,8 @@ func GenManTree(cmd *cobra.Command, header *GenManHeader, dir string) error {
}
needToResetTitle := header.Title == ""
filename := cmd.CommandPath()
filename = dir + strings.Replace(filename, " ", "-", -1) + ".1"
basename := strings.Replace(cmd.CommandPath(), " ", "_", -1) + ".1"
filename := filepath.Join(dir, basename)
f, err := os.Create(filename)
if err != nil {
return err

3
doc/man_docs.md
View file

@ -7,6 +7,7 @@ package main
import (
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
)
func main() {
@ -18,7 +19,7 @@ func main() {
Title: "MINE",
Section: "3",
}
cmd.GenManTree(header, "/tmp")
doc.GenManTree(cmd, header, "/tmp")
}
```

5
doc/md_docs.go
View file

@ -17,6 +17,7 @@ import (
"fmt"
"io"
"os"
"path/filepath"
"sort"
"strings"
"time"
@ -156,8 +157,8 @@ func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHa
}
}
filename := cmd.CommandPath()
filename = dir + strings.Replace(filename, " ", "_", -1) + ".md"
basename := strings.Replace(cmd.CommandPath(), " ", "_", -1) + ".md"
filename := filepath.Join(dir, basename)
f, err := os.Create(filename)
if err != nil {
return err

31
doc/md_docs.md
View file

@ -1,5 +1,26 @@
# Generating Markdown Docs For Your Own cobra.Command
Generating man pages from a cobra command is incredibly easy. An example is as follows:
```go
package main
import (
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
)
func main() {
cmd := &cobra.Command{
Use: "test",
Short: "my test program",
}
doc.GenMarkdownTree(cmd, "/tmp")
}
```
That will get you a Markdown document `/tmp/test.md`
## Generate markdown docs for the entire command tree
This program can actually generate docs for the kubectl command in the kubernetes project
@ -11,13 +32,15 @@ import (
"io/ioutil"
"os"
"github.com/GoogleCloudPlatform/kubernetes/pkg/kubectl/cmd"
"github.com/spf13/cobra/cobra"
kubectlcmd "k8s.io/kubernetes/pkg/kubectl/cmd"
cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
"github.com/spf13/cobra/doc"
)
func main() {
kubectl := cmd.NewFactory(nil).NewKubectlCommand(os.Stdin, ioutil.Discard, ioutil.Discard)
doc.GenMarkdownTree(kubectl, "./")
cmd := kubectlcmd.NewKubectlCommand(cmdutil.NewFactory(nil), os.Stdin, ioutil.Discard, ioutil.Discard)
doc.GenMarkdownTree(cmd, "./")
}
```