MCPcopy
hub / github.com/docker/compose / generateDocs

Function generateDocs

docs/yaml/main/generate.go:31–67  ·  view source on GitHub ↗
(opts *options)

Source from the content-addressed store, hash-verified

29)
30
31func generateDocs(opts *options) error {
32 dockerCLI, err := command.NewDockerCli()
33 if err != nil {
34 return err
35 }
36 cmd := &cobra.Command{
37 Use: "docker",
38 DisableAutoGenTag: true,
39 }
40 cmd.AddCommand(compose.RootCommand(dockerCLI, nil))
41 disableFlagsInUseLine(cmd)
42
43 tool, err := clidocstool.New(clidocstool.Options{
44 Root: cmd,
45 SourceDir: opts.source,
46 TargetDir: opts.target,
47 Plugin: true,
48 })
49 if err != nil {
50 return err
51 }
52 for _, format := range opts.formats {
53 switch format {
54 case "yaml":
55 if err := tool.GenYamlTree(cmd); err != nil {
56 return err
57 }
58 case "md":
59 if err := tool.GenMarkdownTree(cmd); err != nil {
60 return err
61 }
62 default:
63 return fmt.Errorf("unknown format %q", format)
64 }
65 }
66 return nil
67}
68
69func disableFlagsInUseLine(cmd *cobra.Command) {
70 visitAll(cmd, func(ccmd *cobra.Command) {

Callers 1

mainFunction · 0.85

Calls 2

RootCommandFunction · 0.92
disableFlagsInUseLineFunction · 0.85

Tested by

no test coverage detected