docs
No long description provided.
Installation
dagger install github.com/shykes/dagger/docs@bf51019a9bb170531b6f9e1ba1095d371339b65d
Entrypoint
Return Type
Docs !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory | - | No description provided |
nginxConfig | File | - | No description provided |
doctumConfig | File | - | No description provided |
Example
dagger -m github.com/shykes/dagger/docs@bf51019a9bb170531b6f9e1ba1095d371339b65d 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 🔗
source() 🔗
Return Type
Directory !
Example
dagger -m github.com/shykes/dagger/docs@bf51019a9bb170531b6f9e1ba1095d371339b65d call \
source
func (m *myModule) example() *Directory {
return dag.
Docs().
Source()
}
@function
def example() -> dagger.Directory:
return (
dag.docs()
.source()
)
@func()
example(): Directory {
return dag
.docs()
.source()
}
site() 🔗
Build the docs website
Return Type
Directory !
Example
dagger -m github.com/shykes/dagger/docs@bf51019a9bb170531b6f9e1ba1095d371339b65d 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/shykes/dagger/docs@bf51019a9bb170531b6f9e1ba1095d371339b65d 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 !
Example
dagger -m github.com/shykes/dagger/docs@bf51019a9bb170531b6f9e1ba1095d371339b65d 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 !
Example
dagger -m github.com/shykes/dagger/docs@bf51019a9bb170531b6f9e1ba1095d371339b65d 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()
}
generateCli() 🔗
Regenerate the CLI reference docs
Return Type
Directory !
Example
dagger -m github.com/shykes/dagger/docs@bf51019a9bb170531b6f9e1ba1095d371339b65d call \
generate-cli
func (m *myModule) example() *Directory {
return dag.
Docs().
GenerateCli()
}
@function
def example() -> dagger.Directory:
return (
dag.docs()
.generate_cli()
)
@func()
example(): Directory {
return dag
.docs()
.generateCli()
}
generatePhp() 🔗
Generate the PHP SDK API reference documentation
Return Type
Directory !
Example
dagger -m github.com/shykes/dagger/docs@bf51019a9bb170531b6f9e1ba1095d371339b65d call \
generate-php
func (m *myModule) example() *Directory {
return dag.
Docs().
GeneratePhp()
}
@function
def example() -> dagger.Directory:
return (
dag.docs()
.generate_php()
)
@func()
example(): Directory {
return dag
.docs()
.generatePhp()
}
generateSchema() 🔗
Regenerate the API schema
Return Type
Directory !
Example
dagger -m github.com/shykes/dagger/docs@bf51019a9bb170531b6f9e1ba1095d371339b65d call \
generate-schema
func (m *myModule) example() *Directory {
return dag.
Docs().
GenerateSchema()
}
@function
def example() -> dagger.Directory:
return (
dag.docs()
.generate_schema()
)
@func()
example(): Directory {
return dag
.docs()
.generateSchema()
}
generateSchemaReference() 🔗
Regenerate the API Reference documentation
Return Type
Directory !
Example
dagger -m github.com/shykes/dagger/docs@bf51019a9bb170531b6f9e1ba1095d371339b65d call \
generate-schema-reference
func (m *myModule) example() *Directory {
return dag.
Docs().
GenerateSchemaReference()
}
@function
def example() -> dagger.Directory:
return (
dag.docs()
.generate_schema_reference()
)
@func()
example(): Directory {
return dag
.docs()
.generateSchemaReference()
}
generateConfigSchemas() 🔗
Regenerate the config schemas
Return Type
Directory !
Example
dagger -m github.com/shykes/dagger/docs@bf51019a9bb170531b6f9e1ba1095d371339b65d call \
generate-config-schemas
func (m *myModule) example() *Directory {
return dag.
Docs().
GenerateConfigSchemas()
}
@function
def example() -> dagger.Directory:
return (
dag.docs()
.generate_config_schemas()
)
@func()
example(): Directory {
return dag
.docs()
.generateConfigSchemas()
}
bump() 🔗
Bump the Go SDK’s Engine dependency
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
version | String ! | - | No description provided |
Example
dagger -m github.com/shykes/dagger/docs@bf51019a9bb170531b6f9e1ba1095d371339b65d call \
bump --version string
func (m *myModule) example(version string) *Directory {
return dag.
Docs().
Bump(version)
}
@function
def example(version: str) -> dagger.Directory:
return (
dag.docs()
.bump(version)
)
@func()
example(version: string): Directory {
return dag
.docs()
.bump(version)
}
deploy() 🔗
Deploys a current build of the docs.
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
netlifyToken | Secret ! | - | No description provided |
Example
dagger -m github.com/shykes/dagger/docs@bf51019a9bb170531b6f9e1ba1095d371339b65d call \
deploy --netlify-token env:MYSECRET
func (m *myModule) example(ctx context.Context, netlifyToken *Secret) string {
return dag.
Docs().
Deploy(ctx, netlifyToken)
}
@function
async def example(netlify_token: dagger.Secret) -> str:
return await (
dag.docs()
.deploy(netlify_token)
)
@func()
async example(netlifyToken: Secret): Promise<string> {
return dag
.docs()
.deploy(netlifyToken)
}
publish() 🔗
Publish a previous deployment to production - defaults to the latest deployment on the main branch.
Return Type
Void !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
netlifyToken | Secret ! | - | No description provided |
deployment | String | - | No description provided |
Example
dagger -m github.com/shykes/dagger/docs@bf51019a9bb170531b6f9e1ba1095d371339b65d call \
publish --netlify-token env:MYSECRET
func (m *myModule) example(ctx context.Context, netlifyToken *Secret) {
return dag.
Docs().
Publish(ctx, netlifyToken)
}
@function
async def example(netlify_token: dagger.Secret) -> None:
return await (
dag.docs()
.publish(netlify_token)
)
@func()
async example(netlifyToken: Secret): Promise<void> {
return dag
.docs()
.publish(netlifyToken)
}