Dagger
Search

docs

No long description provided.

Installation

dagger install github.com/dagger/dagger/docs@ad997972f96272f3e140e12b12e00ef4d6e9450b

Entrypoint

Return Type 
Docs !
Arguments
NameTypeDescription
sourceDirectory No description provided
Example
dagger -m github.com/dagger/dagger/docs@ad997972f96272f3e140e12b12e00ef4d6e9450b call \

func (m *myModule) example() *Docs  {
	return dag.
			Docs()
}
@function
def example() -> dag.Docs:
	return (
		dag.docs()
	)
@func()
example(): Docs {
	return dag
		.docs()
}

Types

Docs 🔗

site() 🔗

Build the docs website

Return Type 
Directory !
Example
dagger -m github.com/dagger/dagger/docs@ad997972f96272f3e140e12b12e00ef4d6e9450b call \
 site
func (m *myModule) example() *Directory  {
	return dag.
			Docs().
			Site()
}
@function
def example() -> dagger.Directory:
	return (
		dag.docs()
		.site()
	)
@func()
example(): Directory {
	return dag
		.docs()
		.site()
}

server() 🔗

Build the docs server

Return Type 
Container !
Example
dagger -m github.com/dagger/dagger/docs@ad997972f96272f3e140e12b12e00ef4d6e9450b call \
 server
func (m *myModule) example() *Container  {
	return dag.
			Docs().
			Server()
}
@function
def example() -> dagger.Container:
	return (
		dag.docs()
		.server()
	)
@func()
example(): Container {
	return dag
		.docs()
		.server()
}

lint() 🔗

Lint documentation files

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
generateBoolean -Re-generate all files before linting
Example
dagger -m github.com/dagger/dagger/docs@ad997972f96272f3e140e12b12e00ef4d6e9450b call \
 lint
func (m *myModule) example(ctx context.Context)   {
	return dag.
			Docs().
			Lint(ctx)
}
@function
async def example() -> None:
	return await (
		dag.docs()
		.lint()
	)
@func()
async example(): Promise<void> {
	return dag
		.docs()
		.lint()
}

generate() 🔗

Regenerate the API schema and CLI reference docs

Return Type 
Directory !
Arguments
NameTypeDefault ValueDescription
checkBoolean -Return an error if generated files were not up-to-date
Example
dagger -m github.com/dagger/dagger/docs@ad997972f96272f3e140e12b12e00ef4d6e9450b call \
 generate
func (m *myModule) example() *Directory  {
	return dag.
			Docs().
			Generate()
}
@function
def example() -> dagger.Directory:
	return (
		dag.docs()
		.generate()
	)
@func()
example(): Directory {
	return dag
		.docs()
		.generate()
}

generateCliReference() 🔗

Generate the CLI reference documentation page

Return Type 
Directory !
Example
dagger -m github.com/dagger/dagger/docs@ad997972f96272f3e140e12b12e00ef4d6e9450b call \
 generate-cli-reference
func (m *myModule) example() *Directory  {
	return dag.
			Docs().
			GenerateCliReference()
}
@function
def example() -> dagger.Directory:
	return (
		dag.docs()
		.generate_cli_reference()
	)
@func()
example(): Directory {
	return dag
		.docs()
		.generateCliReference()
}

generateApiSchema() 🔗

Generate the API GraphQL schema

Return Type 
Directory !
Example
dagger -m github.com/dagger/dagger/docs@ad997972f96272f3e140e12b12e00ef4d6e9450b call \
 generate-api-schema
func (m *myModule) example() *Directory  {
	return dag.
			Docs().
			GenerateApiSchema()
}
@function
def example() -> dagger.Directory:
	return (
		dag.docs()
		.generate_api_schema()
	)
@func()
example(): Directory {
	return dag
		.docs()
		.generateApiSchema()
}

generateApiReference() 🔗

Generate the API Reference documentation

Return Type 
Directory !
Example
dagger -m github.com/dagger/dagger/docs@ad997972f96272f3e140e12b12e00ef4d6e9450b call \
 generate-api-reference
func (m *myModule) example() *Directory  {
	return dag.
			Docs().
			GenerateApiReference()
}
@function
def example() -> dagger.Directory:
	return (
		dag.docs()
		.generate_api_reference()
	)
@func()
example(): Directory {
	return dag
		.docs()
		.generateApiReference()
}

generateChangelog() 🔗

Generate an up-do-date changelog, using changie

Return Type 
Directory !
Example
dagger -m github.com/dagger/dagger/docs@ad997972f96272f3e140e12b12e00ef4d6e9450b call \
 generate-changelog
func (m *myModule) example() *Directory  {
	return dag.
			Docs().
			GenerateChangelog()
}
@function
def example() -> dagger.Directory:
	return (
		dag.docs()
		.generate_changelog()
	)
@func()
example(): Directory {
	return dag
		.docs()
		.generateChangelog()
}