Dagger
Search

documentation

Build a statically generated documentation directory, container or service using Hugo and Camptocamp branded Docsy theme.

Installation

dagger install github.com/camptocamp/daggerverse/documentation@v0.1.0

Entrypoint

Return Type 
Documentation
Example
func (m *myModule) example() *Documentation  {
	return dag.
			Documentation()
}
@function
def example() -> dag.Documentation:
	return (
		dag.documentation()
	)
@func()
example(): Documentation {
	return dag
		.documentation()
}

Types

Documentation 🔗

Documentation

init() 🔗

Get a directory containing a newly initialized documentation

Return Type 
Directory !
Example
func (m *myModule) example() *Directory  {
	return dag.
			Documentation().
			Init()
}
@function
def example() -> dagger.Directory:
	return (
		dag.documentation()
		.init()
	)
@func()
example(): Directory {
	return dag
		.documentation()
		.init()
}

builder() 🔗

Documentation builder constructor

Return Type 
Builder !
Arguments
NameTypeDefault ValueDescription
directoryDirectory !-Directory containing documentation to build
Example
func (m *myModule) example(directory *Directory) *DocumentationBuilder  {
	return dag.
			Documentation().
			Builder(directory)
}
@function
def example(directory: dagger.Directory) -> dag.DocumentationBuilder:
	return (
		dag.documentation()
		.builder(directory)
	)
@func()
example(directory: Directory): DocumentationBuilder {
	return dag
		.documentation()
		.builder(directory)
}

Builder 🔗

Documentation builder

container() 🔗

Get a container ready to build the documentation

Return Type 
Container !
Example
func (m *myModule) example(directory *Directory) *Container  {
	return dag.
			Documentation().
			Builder(directory).
			Container()
}
@function
def example(directory: dagger.Directory) -> dagger.Container:
	return (
		dag.documentation()
		.builder(directory)
		.container()
	)
@func()
example(directory: Directory): Container {
	return dag
		.documentation()
		.builder(directory)
		.container()
}

build() 🔗

Build the documentation

Return Type 
BuildResult !
Arguments
NameTypeDefault ValueDescription
args[String ! ] -Documentation builder arguments (Hugo arguments)
Example
func (m *myModule) example(directory *Directory) *DocumentationBuildResult  {
	return dag.
			Documentation().
			Builder(directory).
			Build()
}
@function
def example(directory: dagger.Directory) -> dag.DocumentationBuildResult:
	return (
		dag.documentation()
		.builder(directory)
		.build()
	)
@func()
example(directory: Directory): DocumentationBuildResult {
	return dag
		.documentation()
		.builder(directory)
		.build()
}

BuildResult 🔗

Documentation build result

directory() 🔗

Get a directory containing the documentation build result

Return Type 
Directory !
Example
func (m *myModule) example(directory *Directory) *Directory  {
	return dag.
			Documentation().
			Builder(directory).
			Build().
			Directory()
}
@function
def example(directory: dagger.Directory) -> dagger.Directory:
	return (
		dag.documentation()
		.builder(directory)
		.build()
		.directory()
	)
@func()
example(directory: Directory): Directory {
	return dag
		.documentation()
		.builder(directory)
		.build()
		.directory()
}

container() 🔗

Get a container ready to serve the documentation

Container exposes port 8080.

Return Type 
Container !
Example
func (m *myModule) example(directory *Directory) *Container  {
	return dag.
			Documentation().
			Builder(directory).
			Build().
			Container()
}
@function
def example(directory: dagger.Directory) -> dagger.Container:
	return (
		dag.documentation()
		.builder(directory)
		.build()
		.container()
	)
@func()
example(directory: Directory): Container {
	return dag
		.documentation()
		.builder(directory)
		.build()
		.container()
}

server() 🔗

Get a service serving the documentation

See container() for details.

Return Type 
Service !
Example
func (m *myModule) example(directory *Directory) *Service  {
	return dag.
			Documentation().
			Builder(directory).
			Build().
			Server()
}
@function
def example(directory: dagger.Directory) -> dagger.Service:
	return (
		dag.documentation()
		.builder(directory)
		.build()
		.server()
	)
@func()
example(directory: Directory): Service {
	return dag
		.documentation()
		.builder(directory)
		.build()
		.server()
}