0
0
Fork 0
bleve/cmd/bleve/gendocs.go

45 lines
1.2 KiB
Go

// Copyright © 2016 Couchbase, Inc.
//
// 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.
// +build ignore
package main
import (
"fmt"
"github.com/blevesearch/bleve/cmd/bleve/cmd"
"github.com/spf13/cobra/doc"
)
// you can generate markdown docs by running
//
// $ go run gendocs.go
//
// this also requires doc sub-package of cobra
// which is not kept in this repo
// you can acquire it by running
//
// $ gvt restore
func main() {
cmd.RootCmd.DisableAutoGenTag = true
identity := func(s string) string {
return fmt.Sprintf(`{{< relref "docs/%s" >}}`, s)
}
emptyStr := func(s string) string { return "" }
doc.GenMarkdownTreeCustom(cmd.RootCmd, "./", emptyStr, identity)
}