From 4a1296174b006e9a5845a015b1677566539f76c8 Mon Sep 17 00:00:00 2001 From: "Stephen A. Wood" <saw@jlab.org> Date: Tue, 4 Feb 2014 16:06:27 -0500 Subject: [PATCH] Script to generate root style class documentation --- .gitignore | 3 +++ docs/doc_footer.html | 10 ++++++++++ docs/doc_header.html | 20 ++++++++++++++++++++ docs/makehtmldoc.C | 25 +++++++++++++++++++++++++ 4 files changed, 58 insertions(+) create mode 100755 docs/doc_footer.html create mode 100755 docs/doc_header.html create mode 100644 docs/makehtmldoc.C diff --git a/.gitignore b/.gitignore index de46a4f..265ee89 100644 --- a/.gitignore +++ b/.gitignore @@ -36,6 +36,9 @@ config.log *.os \#*\# +# THtml generated documentation directory +docs/htmldoc + # Examples directory examples/*.root examples/*.log.* diff --git a/docs/doc_footer.html b/docs/doc_footer.html new file mode 100755 index 0000000..2f394e0 --- /dev/null +++ b/docs/doc_footer.html @@ -0,0 +1,10 @@ +<br /> +<!--SIGNATURE--> +<div id="footer"> +<em>» Author: %AUTHOR% </em><em>» Copyright %COPYRIGHT%</em><br /> +<em>» Last changed: %CHANGED% </em><em>» Last generated: %GENERATED%</em><br /> +<em>This page has been automatically generated.</em> +</div> +</div> +</body> +</html> diff --git a/docs/doc_header.html b/docs/doc_header.html new file mode 100755 index 0000000..e65ee75 --- /dev/null +++ b/docs/doc_header.html @@ -0,0 +1,20 @@ +<?xml version="1.0"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<!-- --> +<!-- Author: ROOT team (rootdev@pcroot.cern.ch) --> +<!-- --> +<!-- Date: %DATE% --> +<!-- --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=%CHARSET%" /> +<title>%TITLE%</title> +<meta name="rating" content="General" /> +<meta name="objecttype" content="Manual" /> +<meta name="keywords" content="jlab, cebaf, Hall C, SHMS, HMS" /> +<meta name="description" content="Hall C ROOT/C++ Analyzer." /> +<link rel="stylesheet" type="text/css" href="%RELDIR%ROOT.css" id="ROOTstyle" /> +<script type="text/javascript" src="%RELDIR%ROOT.js"></script> +</head> +<body onload="javascript:SetValuesFromCookie();"><div id="body_content"> +<div><center><img src="https://hallcweb.jlab.org/HallC-logo.png" alt="Hall C logo"/></center></div> diff --git a/docs/makehtmldoc.C b/docs/makehtmldoc.C new file mode 100644 index 0000000..4477e4e --- /dev/null +++ b/docs/makehtmldoc.C @@ -0,0 +1,25 @@ +// Generate some autodoc pages by running +// ../hcana makehtmldoc.C +makehtmldoc() { + THtml html; + // Enable the "viewVC header" and "viewVC source" links to work + // But will only work for hcana classes. Links will be broken for + // THa classes. + // Could probably go through all the THa*.html files that are created + // and fix these links, but would need to know the podd branch we are on. + html.SetViewCVS("https://github.com/JeffersonLab/hcana/tree/develop/"); + html.SetProductName("Hall C Analysis Code HCANA"); + html.SetSourceDir("..:../podd"); + html.SetIncludePath(".."); + html.SetHeader("doc_header.html"); + html.SetFooter("doc_footer.html"); + // Create documentation pages for all Classes, hcana and podd + html.MakeAll(); + // Remake the index to list only hcana Classes. Since the + // THa Class document pages were made, we can still click through to + // the THa classes + html.MakeIndex("THc"); +} +// +// To install, do +// rsync -a -e ssh htmldoc/ jlabl1:/group/hallc/www/hallcweb/html/hcanadoc/ -- GitLab