technofab/docsonnet
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/docsonnet.git synced 2026-02-02 15:45:12 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: document plain values (#12)

Browse source 
* feat: document plain values

Adds `d.val` to attach type and help information to plain Jsonnet
values, apart from specially treated `fn` and `obj`.

* feat: defaults
This commit is contained in:
sh0rez 2020-07-27 16:59:04 +02:00 • committed by GitHub
parent 4c6f532e05
commit 2f9dcb2d21
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 99 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

22
pkg/render/render.go
View file

@ -119,6 +119,11 @@ func renderIndex(api docsonnet.Fields, path string, s *slug.Slugger) []md.Elem {
link := "#" + s.Slug("obj "+path+obj.Name)
elems = append(elems, md.Link(md.Code(name), link))
elems = append(elems, md.List(renderIndex(obj.Fields, path+obj.Name+".", s)...))
case v.Value != nil:
val := v.Value
name := md.Text(fmt.Sprintf("%s %s%s", val.Type, path, val.Name))
link := "#" + s.Slug(name.String())
elems = append(elems, md.Link(md.Code(name), link))
}
}
return elems
@ -144,6 +149,23 @@ func renderApi(api docsonnet.Fields, path string) []md.Elem {
md.Text(obj.Help),
)
elems = append(elems, renderApi(obj.Fields, path+obj.Name+".")...)
case v.Value != nil:
val := v.Value
elems = append(elems,
md.Headline(3, fmt.Sprintf("%s %s%s", val.Type, path, val.Name)),
)
if val.Default != nil {
elems = append(elems, md.Paragraph(
md.Italic(md.Text("Default value: ")),
md.Code(md.Text(fmt.Sprint(val.Default))),
))
}
elems = append(elems,
md.Text(val.Help),
)
}
}