docs

Documentation

Overview

Package docs provides the defined CLI docs actions for Vela.

Usage:

import "github.com/go-vela/cli/action/docs"

Index

• type Config
  • func (c *Config) Generate(a *cli.App) error
  • func (c *Config) Validate() error

Types

type Config

type Config struct {
	Action   string
	Markdown bool
	Man      bool
}

Config represents the configuration necessary to perform docs related requests with Vela.

func (*Config) Generate

func (c *Config) Generate(a *cli.App) error

Generate produces documentation for the CLI.

func (*Config) Validate

func (c *Config) Validate() error

Validate verifies the configuration provided.