Dagger
Search

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@cfa178e7e9b5eef860e7c8e8d5720e98a767a34b

Entrypoint

Return Type
CrdRefDocs !
Arguments
NameTypeDefault ValueDescription
imageString "golang:1.24.5-alpine"Go image to use. renovate image: datasource=docker depName=golang versioning=docker
versionString "master"CrdRefDocs version to use.
Example
dagger -m github.com/cloudnative-pg/daggerverse/crd-ref-docs@cfa178e7e9b5eef860e7c8e8d5720e98a767a34b 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
NameTypeDefault ValueDescription
srcDirectory !-The directory of the sources
sourcePathString !-The path of the CRD files, relative to the source directory.
configFileString -The path of the config file, relative to the source directory.
templatesDirString -The path of the template director, relative to the source directory.
rendererEnum "ASCIIDOC"The renderer for the generated documentation.
outputModeEnum "SINGLE"The output mode for the generated documentation.
logLevelString "INFO"Log level.
maxDepthInteger 10Maximum recursion level for type discovery.
outputPathString -Output path for the generated documentation.
Example
dagger -m github.com/cloudnative-pg/daggerverse/crd-ref-docs@cfa178e7e9b5eef860e7c8e8d5720e98a767a34b 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)
}