docs

package

v0.0.0-...-b75375f Latest Latest Go to latest Published: Nov 10, 2014 License: MPL-2.0 Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kristofer/gondola

Links

Open Source Insights

Documentation ¶

Overview ¶

Package docs implements a Gondola application for browsing package documentation.

This application requires a Go source code checkout to be present on the server as well as GOROOT and GOPATH properly configured. Additionaly, a working Go installation is required to automatically download and update packages.

To configure the packages to list in the index, use the Groups variable.

This application can also automatically fetch and update the packages listed in the index. See StartUpdatingPackages and StopUpdatingPackages.

Index ¶

Constants
Variables
func StartUpdatingPackages(interval time.Duration)
func StopUpdatingPackages()
type Group

Constants ¶

View Source

const (
	ListHandlerName    = "docs-list"
	StdListHandlerName = "docs-std-list"
	PackageHandlerName = "docs-package"
	SourceHandlerName  = "docs-source"
)

Variables ¶

View Source

var (
	PackageTemplateName  = "package.html"
	PackagesTemplateName = "packages.html"
	SourceTemplateName   = "source.html"

	ListHandler    = app.NamedHandler(ListHandlerName, listHandler)
	StdListHandler = app.NamedHandler(StdListHandlerName, stdListHandler)
	PackageHandler = app.NamedHandler(PackageHandlerName, packageHandler)
	SourceHandler  = app.NamedHandler(SourceHandlerName, sourceHandler)
)

View Source

var (
	App = app.New()
)

View Source

var (
	DefaultContext = &doc.DefaultContext
)

View Source

var (
	// Groups includes the packages to list in the package index.
	// See the Group struct for further information.
	Groups []*Group
)

Functions ¶

func StartUpdatingPackages ¶

func StartUpdatingPackages(interval time.Duration)

StartUpdatingPackages starts regularly updating the packages listed in Groups at the given interval. Note that for updating packages, the system should have installed the client for the SCM systems used by them (e.g. git, hg, etc...). A working Go installation on the host is also required, since go get will be used to download them.

func StopUpdatingPackages ¶

func StopUpdatingPackages()

StopUpdatingPackages stops updating packages. Note that an in-flight update won't be stopped, but no more updates will be scheduled.

Types ¶

type Group ¶

type Group struct {
	Title    string
	Packages []string
}

Group represents a group of packages to be displayed under the same title. Note that all subpackages of any included package will also be listed. Packages must be referred by their import path (e.g. example.com/pkg).

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
doc
printer Package printer implements printing of AST nodes.	Package printer implements printing of AST nodes.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL