mirror of https://github.com/helm/helm
This adds a hidden 'helm doc' command that generates documentation out of the Helm help text. Currently it can create: - man pages for HELM(1) - Markdown documentation - bash autocompletions Those are the three built-ins for Cobra. The command is hidden so that it doesn't show up to the regular user, since this is really a specialized task. It has the advantage of making it trivially easy to install man pages and bash completion at installation time.reviewable/pr1484/r1
Matt Butcher
9 years ago
parent
846011b02a
commit
28c29c60a4
@ -0,0 +1,80 @@
|
||||
/*
|
||||
Copyright 2016 The Kubernetes Authors All rights reserved.
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
"github.com/spf13/cobra/doc"
|
||||
)
|
||||
|
||||
const docsDesc = `
|
||||
Generate documentation files for Helm.
|
||||
|
||||
This command can generate documentation for Helm in the following formats:
|
||||
|
||||
- Markdown
|
||||
- Man pages
|
||||
|
||||
It can also generate bash autocompletions.
|
||||
|
||||
$ helm docs markdown -dir mydocs/
|
||||
`
|
||||
|
||||
type docsCmd struct {
|
||||
out io.Writer
|
||||
dest string
|
||||
docTypeString string
|
||||
topCmd *cobra.Command
|
||||
}
|
||||
|
||||
func newDocsCmd(out io.Writer, topCmd *cobra.Command) *cobra.Command {
|
||||
dc := &docsCmd{out: out, topCmd: topCmd}
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "docs",
|
||||
Short: "Generate documentation as markdown or man pages",
|
||||
Long: docsDesc,
|
||||
Hidden: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
dc.run()
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
f := cmd.Flags()
|
||||
f.StringVar(&dc.dest, "dir", "./", "directory to which documentation is written")
|
||||
f.StringVar(&dc.docTypeString, "type", "markdown", "the type of documentation to generate (markdown, man, bash)")
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
||||
func (d *docsCmd) run() error {
|
||||
switch d.docTypeString {
|
||||
case "markdown", "mdown", "md":
|
||||
return doc.GenMarkdownTree(d.topCmd, d.dest)
|
||||
case "man":
|
||||
manHdr := &doc.GenManHeader{Title: "HELM", Section: "1"}
|
||||
return doc.GenManTree(d.topCmd, manHdr, d.dest)
|
||||
case "bash":
|
||||
return d.topCmd.GenBashCompletionFile(filepath.Join(d.dest, "completions.bash"))
|
||||
default:
|
||||
return fmt.Errorf("unknown doc type %q. Try 'markdown' or 'man'", d.docTypeString)
|
||||
}
|
||||
}
|
||||
Loading…
Reference in new issue