forked from pydio/cells
-
Notifications
You must be signed in to change notification settings - Fork 0
/
hidden-doc-generate.go
60 lines (51 loc) · 1.86 KB
/
hidden-doc-generate.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/*
* Copyright (c) 2018. Abstrium SAS <team (at) pydio.com>
* This file is part of Pydio Cells.
*
* Pydio Cells is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Pydio Cells is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with Pydio Cells. If not, see <http://www.gnu.org/licenses/>.
*
* The latest code can be found at <https://pydio.com>.
*/
package cmd
import (
"log"
"github.com/pydio/go/docs"
"github.com/spf13/cobra"
"github.com/pydio/cells/common"
)
var docPath string
var generateDocCmd = &cobra.Command{
Use: "commands",
Short: "Generate MD and YAML documentation for all Cells commands",
Long: `Generate Markdown documentation for the Cells command line tool.
Provide a target folder where to put the generated files.
This command also generates yaml files for pydio.com documentation format.
`,
Run: func(cmd *cobra.Command, args []string) {
if docPath == "" {
log.Fatal("Please provide a path to store output files")
} else {
docs.PydioDocsGeneratedBy = common.PackageLabel + " v" + common.Version().String()
err := docs.GenMarkdownTree(RootCmd, docPath)
if err != nil {
log.Fatal(err)
}
}
},
}
func init() {
generateDocCmd.Flags().StringVarP(&docPath, "path", "p", "", "Target folder where to put the files")
generateDocCmd.Flags().StringVarP(&docs.PydioDocsMenuName, "menu", "m", "menu-admin-guide-v7", "Pydio Docs menu name")
DocCmd.AddCommand(generateDocCmd)
}