#import "@preview/cmarker:0.1.6": render
// re-export page template
#import "/typ/packages/package-docs/template.typ": project
#let module-divider = html.elem("hr", attrs: (class: "module-divider"));
#show link: it => if type(it.dest) == label {
html.elem("a", attrs: (href: "#" + str(it.dest), class: "symbol-link"), it.body)
} else {
it
}
#let heading-label(name) = {
let it = name.replace(regex("[\s\:]"), "-").replace(regex("[.()]"), "").replace(regex("-+"), "-").replace("M", "m")
label(it)
}
#let labelled-heading(depth, it) = {
heading(depth: depth, html.elem("span", attrs: (id: str(heading-label(it))), it))
}
#let markdown-docs = render.with(
scope: (
image: (src, alt: none) => {
html.elem("img", attrs: (src: src, alt: alt, class: "code-image"))
},
),
)
#let display-package-spec(pkg-spec) = {
"@"
pkg-spec.meta.namespace
"/"
pkg-spec.meta.name
":"
pkg-spec.meta.version
}
#let span = html.elem.with("span")
#let code = html.elem.with("code")
#let keyword = code.with(attrs: (class: "code-kw"))
#let builtin-ty = code.with(attrs: (class: "type-builtin"))
#let symbol-doc(symbol-ctx, info) = {
// let ident = if !primary.is_empty() {
// eco_format!("symbol-{}-{primary}.{}", child.kind, child.name)
// } else {
// eco_format!("symbol-{}-{}", child.kind, child.name)
// };
let symlink(body) = if info.symbol_link != none {
// let _ = writeln!(out, "#link({})[Symbol Docs]\n", TypstLink(lnk));
html.elem("a", attrs: (href: info.symbol_link, class: "symbol-link"), body)
} else {
body
}
if info.is_external {
let fid = info.loc.at(0, default: none)
let file = symbol-ctx.files.at(fid, default: none)
let package = symbol-ctx.packages.at(file.package, default: none)
let title = if info.kind == "module" {
let title = if package != none and file.package > 0 {
span(attrs: (title: display-package-spec(package)), "external")
code(" ")
code(file.path)
} else {
code(file.path)
}
symlink(code(title))
} else {
// keyword("extern")
// code(" ")
symlink(code(info.name))
if info.kind == "function" {
code("()")
} else {
code(": ")
builtin-ty[any]
}
}
html.elem("div", attrs: (class: "detail-header doc-symbol-" + info.kind), [=== #title])
if info.oneliner != none {
markdown-docs(info.oneliner)
}
return
}
labelled-heading(3, info.kind + ": " + info.name + " in " + symbol-ctx.in-module)
// if info.symbol_link != none {
// // let _ = writeln!(out, "#link({})[Symbol Docs]\n", TypstLink(lnk));
// par(symlink("Symbol Docs"))
// }
// let convert_err = None::<EcoString>;
if info.parsed_docs != none {
if info.parsed_docs.kind == "func" {
// if let Some(DefDocs::Function(sig)) = &info.parsed_docs {
// // let _ = writeln!(out, "<!-- begin:sig -->");
// let _ = writeln!(out, "```typc");
// let _ = write!(out, "let {}", info.name);
// let _ = sig.print(&mut out);
// let _ = writeln!(out, ";");
// let _ = writeln!(out, "```");
// // let _ = writeln!(out, "<!-- end:sig -->");
// }
// repr(info.parsed_docs)
}
}
let printed_docs = false
if not info.is_external {
// let convert_err = None::<EcoString>;
if info.parsed_docs != none {
let docs = info.parsed_docs
if docs.docs != none and docs.docs.len() > 0 {
// remove_list_annotations(docs.docs())
printed_docs = true
markdown-docs(docs.docs)
}
if docs.kind == "func" {
labelled-heading(4, "Resultant")
docs.ret_ty.at(0)
labelled-heading(4, "Parameters")
let pos = docs.at("pos", default: ())
let named = docs.at("named", default: (:)).values()
let rest = docs.at("rest", default: none)
let params = pos + named
if rest != none {
params.push(rest)
}
for param in params {
labelled-heading(5, param.name)
let param-head = (param.name, ": ", param.cano_type.at(0))
if param.positional {
param-head.push(" (Positional)")
}
if param.variadic {
param-head.push(" (Variadic)")
}
if param.settable {
param-head.push(" (Settable)")
}
if param.named {
param-head.push(" (Named, default: ")
param-head.push(param.default)
param-head.push(")")
}
raw(block: true, param-head.join())
markdown-docs(param.docs)
}
}
}
}
if not printed_docs {
let plain_docs = info.docs
if plain_docs == none {
plain_docs = info.oneliner
}
// todo: eval with error tolerance?
// if plain_docs != none {
// eval(plain_docs, mode: "markup")
// }
// if let Some(lnk) = &child.module_link {
// match lnk.as_str() {
// "builtin" => {
// let _ = writeln!(out, "A Builtin Module");
// }
// _lnk => {
// // let _ = writeln!(out, "#link({})[Module Docs]\n",
// // TypstLink(lnk));
// }
// }
// }
// // let _ = writeln!(out, "<!-- end:symbol {ident} -->");
// let _ = writeln!(out, "]),");
}
}
#let analyze-package(p) = {
(
packages: p.packages,
files: p.files,
)
}
#let analyze-module(m) = {
let modules = ()
let functions = ()
let constants = ()
let unknowns = ()
for child in m.children {
if child.kind == "module" {
modules.push(child)
} else if child.kind == "function" {
functions.push(child)
} else if child.kind == "variable" {
constants.push(child)
} else {
unknowns.push(child)
}
}
(
modules: modules.sorted(key: it => it.id),
functions: functions,
constants: constants,
unknowns: unknowns,
)
}
#let module-doc(info: none, name: none, symbol-ctx, m) = {
let m = analyze-module(m)
if info.prefix.len() > 0 {
let primary = info.prefix
let title = "Module: " + primary + " in " + info.prefix
module-divider
labelled-heading(1, title)
} else {
labelled-heading(1, "Package Exports")
}
let symbol-ctx = (
in-module: info.prefix,
..symbol-ctx,
)
if m.modules.len() > 0 {
[== Modules]
for child in m.modules {
symbol-doc(symbol-ctx, child)
}
}
if m.constants.len() > 0 {
[== Constants]
for child in m.constants {
symbol-doc(symbol-ctx, child)
}
}
if m.functions.len() > 0 {
[== Functions]
for child in m.functions {
symbol-doc(symbol-ctx, child)
}
}
if m.unknowns.len() > 0 {
[== Unknowns]
for child in m.unknowns {
symbol-doc(symbol-ctx, child)
}
}
}
#let package-doc(info) = {
let info = json(info)
let title = "@" + info.meta.namespace + "/" + info.meta.name + " " + info.meta.version
show: project.with(title: title)
html.elem("style", read("/typ/packages/package-docs/global.css"))
show: html.elem.with("main")
strong[
This documentation is generated locally. Please submit issues to #link("https://github.com/Myriad-Dreamin/tinymist")[tinymist] if you see incorrect information in it.
]
html.elem("h1", attrs: (id: "package-doc-title"), title)
let repo = info.meta.manifest.package.at("repository", default: none)
if repo != none {
let repo_link = html.elem("a", attrs: (href: repo, class: "package-repo-link"), "Repository")
html.elem("p", repo_link)
}
let description = info.meta.manifest.package.at("description", default: none)
if description != none {
description
}
let symbol-ctx = analyze-package(info)
for (name, m, info) in info.modules {
module-doc(info: info, name: name, symbol-ctx, m)
}
}