<$head_tag>$sym_name$hash_link')
if link.len != 0 {
dnw.write('
$link_svg')
@@ -256,31 +279,54 @@ fn doc_node_html(dd doc.DocNode, link string, head bool, tb &table.Table) string
return dnw.str()
}
+fn write_toc(cn doc.DocNode, nodes []doc.DocNode, toc &strings.Builder) {
+ toc.write('
${cn.name}')
+ children := nodes.find_children_of(cn.name)
+ if children.len != 0 && cn.name != 'Constants' {
+ toc.writeln(' ')
+ for child in children {
+ cname := cn.name + '.' + child.name
+ toc.writeln('- ${child.name}
')
+ }
+ toc.writeln('
')
+ }
+ toc.writeln('')
+}
+
+fn (cfg DocConfig) write_content(cn &doc.DocNode, dcs &doc.Doc, hw &strings.Builder) {
+ base_dir := os.base_dir(os.real_path(cfg.input_path))
+ file_path_name := cn.file_path.replace('$base_dir/', '')
+ src_link := get_src_link(cfg.manifest.repo_url, file_path_name, cn.pos.line)
+ children := dcs.contents.find_children_of(cn.name)
+ hw.write(doc_node_html(cn, src_link, false, dcs.table))
+ if children.len != 0 {
+ for child in children {
+ child_file_path_name := child.file_path.replace('$base_dir/', '')
+ child_src_link := get_src_link(cfg.manifest.repo_url, child_file_path_name, child.pos.line)
+ hw.write(doc_node_html(child, child_src_link, false, dcs.table))
+ }
+ }
+}
+
fn (cfg DocConfig) gen_html(idx int) string {
dcs := cfg.docs[idx]
time_gen := '$dcs.time_generated.day $dcs.time_generated.smonth() $dcs.time_generated.year $dcs.time_generated.hhmmss()'
mut hw := strings.new_builder(200)
mut toc := strings.new_builder(200)
// generate toc first
+ const_node_idx := dcs.contents.index_by_name('Constants') or { -1 }
+ if const_node_idx != -1 {
+ write_toc(dcs.contents[const_node_idx], dcs.contents, &toc)
+ }
for cn in dcs.contents {
- if cn.parent_type !in ['void', ''] { continue }
- toc.write('
${cn.name}')
- children := dcs.contents.find_children_of(cn.name)
- if children.len != 0 && cn.name != 'Constants' {
- toc.writeln(' ')
- for child in children {
- cname := cn.name + '.' + child.name
- toc.writeln('- ${child.name}
')
- }
- toc.writeln('
')
- }
- toc.writeln('')
+ if cn.name == 'Constants' || cn.parent_type !in ['void', ''] { continue }
+ write_toc(cn, dcs.contents, &toc)
} // write head
// get resources
- doc_css := cfg.get_resource('doc.css', true)
- normalize_css := cfg.get_resource('normalize.css', true)
- doc_js := cfg.get_resource('doc.js', false)
+ doc_css := cfg.get_resource(css_js_assets[0], true)
+ normalize_css := cfg.get_resource(css_js_assets[1], true)
+ doc_js := cfg.get_resource(css_js_assets[2], !cfg.serve_http)
light_icon := cfg.get_resource('light.svg', true)
dark_icon := cfg.get_resource('dark.svg', true)
menu_icon := cfg.get_resource('menu.svg', true)
@@ -369,20 +415,12 @@ fn (cfg DocConfig) gen_html(idx int) string {
hw.write('\n\n')
hw.write('
\n
\n')
hw.write(doc_node_html(dcs.head, '', true, dcs.table))
+ if const_node_idx != -1 {
+ cfg.write_content(&dcs.contents[const_node_idx], &dcs, &hw)
+ }
for cn in dcs.contents {
- if cn.parent_type !in ['void', ''] { continue }
- base_dir := os.base_dir(os.real_path(cfg.input_path))
- file_path_name := cn.file_path.replace('$base_dir/', '')
- hw.write(doc_node_html(cn, get_src_link(cfg.manifest.repo_url, file_path_name, cn.pos.line), false, dcs.table))
-
- children := dcs.contents.find_children_of(cn.name)
-
- if children.len != 0 {
- for child in children {
- child_file_path_name := child.file_path.replace('$base_dir/', '')
- hw.write(doc_node_html(child, get_src_link(cfg.manifest.repo_url, child_file_path_name, child.pos.line), false, dcs.table))
- }
- }
+ if cn.parent_type !in ['void', ''] || cn.name == 'Constants' { continue }
+ cfg.write_content(&cn, &dcs, &hw)
}
hw.write('\n\n
\n')
if cfg.is_multi && cfg.docs.len > 1 && dcs.head.name != 'README' {
@@ -573,7 +611,7 @@ fn (mut cfg DocConfig) generate_docs_from_file() {
panic(err)
}
} else {
- for fname in ['doc.css', 'normalize.css' 'doc.js'] {
+ for fname in css_js_assets {
os.rm(os.join_path(cfg.output_path, fname))
}
}
@@ -645,7 +683,7 @@ fn (cfg DocConfig) get_resource(name string, minify bool) string {
path := os.join_path(res_path, name)
mut res := os.read_file(path) or { panic('could not read $path') }
if minify {
- res = res.replace('\n', ' ')
+ res = if name.ends_with('.js') { js_compress(res) } else { res.replace('\n', ' ') }
}
// TODO: Make SVG inline for now
if cfg.inline_assets || path.ends_with('.svg') {
diff --git a/vlib/v/doc/doc.v b/vlib/v/doc/doc.v
index 2ebf552d45..194c0b7f3d 100644
--- a/vlib/v/doc/doc.v
+++ b/vlib/v/doc/doc.v
@@ -178,6 +178,14 @@ pub fn new(input_path string) Doc {
}
}
+pub fn (nodes []DocNode) index_by_name(node_name string) ?int {
+ for i, node in nodes {
+ if node.name != node_name { continue }
+ return i
+ }
+ return error('Node with the name "$node_name" was not found.')
+}
+
pub fn (nodes []DocNode) find_children_of(parent_type string) []DocNode {
if parent_type.len == 0 {
return []DocNode{}