docs

package

v1.1.0 Latest Latest Go to latest Published: May 28, 2024 License: BSD-2-Clause Imports: 12 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/Jumpaku/cyamli

Links

Open Source Insights

Documentation ¶

Index ¶

func Generate(schema *schema.Schema, args GenerateArgs, out io.Writer) error
type DocsFormat
type GenerateArgs

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Generate ¶

func Generate(schema *schema.Schema, args GenerateArgs, out io.Writer) error

Types ¶

type DocsFormat ¶

type DocsFormat string

const (
	DocsFormatUnspecified DocsFormat = ""
	DocsFormatText        DocsFormat = "text"
	DocsFormatMarkdown    DocsFormat = "markdown"
	DocsFormatHTML        DocsFormat = "html"
)

type GenerateArgs ¶

type GenerateArgs struct {
	Format     DocsFormat
	All        bool
	Subcommand name.Path
}

Source Files ¶

View all Source files

generate.go

Directories ¶

Path	Synopsis
data

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