github.com/shohhei1126/hugo@v0.42.2-0.20180623210752-3d5928889ad7/tpl/cast/docshelper.go (about)

     1  // Copyright 2017 The Hugo Authors. All rights reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  // http://www.apache.org/licenses/LICENSE-2.0
     7  //
     8  // Unless required by applicable law or agreed to in writing, software
     9  // distributed under the License is distributed on an "AS IS" BASIS,
    10  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package cast
    15  
    16  import (
    17  	"github.com/gohugoio/hugo/deps"
    18  	"github.com/gohugoio/hugo/docshelper"
    19  	"github.com/gohugoio/hugo/tpl/internal"
    20  	"github.com/spf13/viper"
    21  )
    22  
    23  // This file provides documentation support and is randomly put into this package.
    24  func init() {
    25  	docsProvider := func() map[string]interface{} {
    26  		docs := make(map[string]interface{})
    27  		d := &deps.Deps{Cfg: viper.New()}
    28  
    29  		var namespaces internal.TemplateFuncsNamespaces
    30  
    31  		for _, nsf := range internal.TemplateFuncsNamespaceRegistry {
    32  			nf := nsf(d)
    33  			namespaces = append(namespaces, nf)
    34  
    35  		}
    36  
    37  		docs["funcs"] = namespaces
    38  		return docs
    39  	}
    40  
    41  	docshelper.AddDocProvider("tpl", docsProvider)
    42  }