Files
herolib/doc.vsh
2024-12-25 08:40:56 +01:00

67 lines
2.0 KiB
GLSL

#!/usr/bin/env -S v -n -w -gc none -no-retry-compilation -cc tcc -d use_openssl -enable-globals run
import os
abs_dir_of_script := dir(@FILE)
// Format code
println('Formatting code...')
os.system('v fmt -w ${abs_dir_of_script}/examples') or {
eprintln('Warning: Failed to format examples: ${err}')
}
os.system('v fmt -w ${abs_dir_of_script}/herolib') or {
eprintln('Warning: Failed to format herolib: ${err}')
}
// Clean existing docs
println('Cleaning existing documentation...')
os.rmdir_all('${abs_dir_of_script}/docs') or {}
herolib_path := os.join_path(abs_dir_of_script, 'herolib')
os.chdir(herolib_path) or {
panic('Failed to change directory to herolib: ${err}')
}
os.rmdir_all('_docs') or {}
os.rmdir_all('docs') or {}
// Generate HTML documentation
println('Generating HTML documentation...')
os.system('v doc -m -f html . -readme -comments -no-timestamp') or {
panic('Failed to generate HTML documentation: ${err}')
}
// Move docs to parent directory
os.rename('_docs', '${abs_dir_of_script}/docs') or {
panic('Failed to move documentation to parent directory: ${err}')
}
// Generate Markdown documentation
println('Generating Markdown documentation...')
os.rmdir_all('vdocs') or {}
os.mkdir_all('vdocs/v') or {
panic('Failed to create v docs directory: ${err}')
}
os.mkdir_all('vdocs/crystal') or {
panic('Failed to create crystal docs directory: ${err}')
}
os.system('v doc -m -no-color -f md -o vdocs/v/') or {
panic('Failed to generate V markdown documentation: ${err}')
}
os.system('v doc -m -no-color -f md -o vdocs/crystal/') or {
panic('Failed to generate Crystal markdown documentation: ${err}')
}
// Open documentation in browser on non-Linux systems
$if !linux {
os.chdir(abs_dir_of_script) or {
panic('Failed to change directory: ${err}')
}
os.system('open docs/index.html') or {
eprintln('Warning: Failed to open documentation in browser: ${err}')
}
}
println('Documentation generation completed successfully!')