Skip to content
Snippets Groups Projects
Commit 5704422c authored by Stephen A. Wood's avatar Stephen A. Wood
Browse files

Move Doxyfile into docs directory and remove THtml documentation stuff

  docs/Makefile now builds doxygen docs in docs/html
  If you want documentation to be build elsewhere, define
  DOXYGEN_OUTPUT_DIRECTORY and run doxygen by hand
parent 7a0fa954
No related branches found
No related tags found
No related merge requests found
......@@ -37,8 +37,8 @@ config.log
*.pcm
\#*\#
# THtml generated documentation directory
docs/htmldoc
# Doxygen generated documentation directory
docs/html
# Examples directory
examples/*.root
......
......@@ -41,7 +41,7 @@ PROJECT_NUMBER =
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = ../doxygen_output
OUTPUT_DIRECTORY = $(DOXYGEN_OUTPUT_DIRECTORY)
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
......@@ -571,7 +571,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = README.md podd/src podd/hana_decode src
INPUT = ../README.md ../src ../podd/src ../podd/hana_decode
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
......
.PHONY: doxygen clean
DOXYGEN_OUTPUT_DIRECTORY ?= .
export DOXYGEN_OUTPUT_DIRECTORY
export DOXYGEN_SOURCE_DIRECTORY := ..
all: doxygen
doxygen:
doxygen
clean:
rm -r $(DOXYGEN_OUTPUT_DIRECTORY)/html
<br />
<!--SIGNATURE-->
<div id="footer">
<em>&raquo; Author: %AUTHOR% </em><em>&raquo; Copyright %COPYRIGHT%</em><br />
<em>&raquo; Last changed: %CHANGED% </em><em>&raquo; Last generated: %GENERATED%</em><br />
<em>This page has been automatically generated.</em>
</div>
</div>
</body>
</html>
<?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>
// 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/
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment