crd-ref-docs
Installation
Entrypoint
Types
CrdRefDocs
- generate()

crd-ref-docs

A Dagger module for generating CRD reference documentation using the crd-ref-docs tool

Installation

dagger install github.com/cloudnative-pg/daggerverse/crd-ref-docs@807009f26f001db92d552d23f58cef512af91f12

Entrypoint

Return Type

CrdRefDocs !

Arguments

Name	Type	Default Value	Description
image	String	"golang:1.24.2-alpine"	Go image to use. renovate image: datasource=docker depName=golang versioning=docker
version	String	"master"	CrdRefDocs version to use.

Example

dagger -m github.com/cloudnative-pg/daggerverse/crd-ref-docs@807009f26f001db92d552d23f58cef512af91f12 call \

func (m *myModule) example() *dagger.CrdRefDocs  {
	return dag.
			CrdRefDocs()
}

@function
def example() -> dagger.CrdRefDocs:
	return (
		dag.crd_ref_docs()
	)

@func()
example(): CrdRefDocs {
	return dag
		.crdRefDocs()
}

Types

CrdRefDocs 🔗

generate() 🔗

Return Type

Container !

Arguments

Name	Type	Default Value	Description
src	Directory !	-	The directory of the sources
sourcePath	String !	-	The path of the CRD files, relative to the source directory.
configFile	String	-	The path of the config file, relative to the source directory.
templatesDir	String	-	The path of the template director, relative to the source directory.
renderer	Enum	"asciidoc"	The renderer for the generated documentation.
outputMode	Enum	"single"	The output mode for the generated documentation.
logLevel	String	"INFO"	Log level.
maxDepth	Integer	10	Maximum recursion level for type discovery.
outputPath	String	-	Output path for the generated documentation.

Example

dagger -m github.com/cloudnative-pg/daggerverse/crd-ref-docs@807009f26f001db92d552d23f58cef512af91f12 call \
 generate --src DIR_PATH --source-path string

func (m *myModule) example(src *dagger.Directory, sourcePath string) *dagger.Container  {
	return dag.
			CrdRefDocs().
			Generate(src, sourcePath)
}

@function
def example(src: dagger.Directory, source_path: str) -> dagger.Container:
	return (
		dag.crd_ref_docs()
		.generate(src, source_path)
	)

@func()
example(src: Directory, sourcePath: string): Container {
	return dag
		.crdRefDocs()
		.generate(src, sourcePath)
}