#!/bin/bash
# dev/docs/html - HTML documentation generation support

set -e

lib_load 'dev/docs/config'
lib_load 'doc/html'


######
# Common HTML Support

docs_html_url() {
	local url=${1#$package_docs_gendir}
	html_url "$package_docs_urlbase$url" "$2"
}

docs_gen_footer() {
	html_hr
	echo

	local pkgtoolver="${package_name} ${script_name} v${package_version}"
	html_div "Generated on $(date) by ${pkgtoolver}."
	echo
}

docs_gen_html_index_link() {
	local path=$1
	local label=$2

	local urllabel=$(html_h4 "View the $label Index")
	html_div_func docs_html_url "$path" "$urllabel"
	echo
}

docs_gen_html_page_footer() {
	html_hr
	echo

	local path=$(docs_filename "$package_docs_guidedir" index html)
	docs_gen_html_index_link "$path" "Developer Guide"

	local path=$(docs_filename "$package_docs_refdir" index html)
	docs_gen_html_index_link "$path" "Reference Manual"

	docs_gen_footer

	echo "</body>"
	echo "</html>"
}

View the Developer Guide Index

View the Reference Manual Index


Generated on Thu May 4 18:59:35 PDT 2017 by mcsh i7 v0.19.0.