mirror of
https://github.com/TECHNOFAB11/docsonnet.git
synced 2025-12-12 06:20:12 +01:00
feat: add newSub (#44)
This commit is contained in:
parent
b5a6b0e838
commit
5e45c19fbe
3 changed files with 35 additions and 2 deletions
5
Makefile
5
Makefile
|
|
@ -7,6 +7,7 @@ release:
|
||||||
goreleaser release --rm-dist
|
goreleaser release --rm-dist
|
||||||
|
|
||||||
docs:
|
docs:
|
||||||
jsonnet -S -c -m doc-util/ \
|
cd doc-util && \
|
||||||
-e "(import 'doc-util/main.libsonnet').render(import 'doc-util/main.libsonnet')"
|
jsonnet -S -c -m . \
|
||||||
|
-e "(import './main.libsonnet').render(import './main.libsonnet')"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -38,6 +38,7 @@ local d = import "github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet"
|
||||||
* [`obj T`](#obj-t)
|
* [`obj T`](#obj-t)
|
||||||
* [`obj package`](#obj-package)
|
* [`obj package`](#obj-package)
|
||||||
* [`fn new(name, url, help, filename='', version='master')`](#fn-packagenew)
|
* [`fn new(name, url, help, filename='', version='master')`](#fn-packagenew)
|
||||||
|
* [`fn newSub(name, help)`](#fn-packagenewsub)
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
|
|
@ -202,3 +203,17 @@ Arguments:
|
||||||
* `filename` for the import, defaults to blank for backward compatibility
|
* `filename` for the import, defaults to blank for backward compatibility
|
||||||
* `version` for jsonnet-bundler install, defaults to `master` just like jsonnet-bundler
|
* `version` for jsonnet-bundler install, defaults to `master` just like jsonnet-bundler
|
||||||
|
|
||||||
|
|
||||||
|
#### fn package.newSub
|
||||||
|
|
||||||
|
```ts
|
||||||
|
newSub(name, help)
|
||||||
|
```
|
||||||
|
|
||||||
|
`newSub` creates a package without the preconfigured install/usage templates.
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
|
||||||
|
* given `name`
|
||||||
|
* `help` text
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -49,6 +49,23 @@
|
||||||
'local %(name)s = import "%(import)s"'
|
'local %(name)s = import "%(import)s"'
|
||||||
),
|
),
|
||||||
|
|
||||||
|
'#newSub':: d.fn(|||
|
||||||
|
`newSub` creates a package without the preconfigured install/usage templates.
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
|
||||||
|
* given `name`
|
||||||
|
* `help` text
|
||||||
|
|||, [
|
||||||
|
d.arg('name', d.T.string),
|
||||||
|
d.arg('help', d.T.string),
|
||||||
|
]),
|
||||||
|
newSub(name, help)::
|
||||||
|
{
|
||||||
|
name: name,
|
||||||
|
help: help,
|
||||||
|
},
|
||||||
|
|
||||||
withUsageTemplate(template):: {
|
withUsageTemplate(template):: {
|
||||||
usageTemplate: template,
|
usageTemplate: template,
|
||||||
},
|
},
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue