Makefile.docs

Revision 19735, 5.3 kB (checked in by patrick, 2 years ago)
Setting TWEEK_BASE_DIR and JCCL_BASE_DIR prior to rendering the documentation makes the Java API documentation much, much better. Print a warning if one or both of these are not set when starting the rendering process.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`

Line
1	# ************ <auto-copyright.pl BEGIN do not edit this line> ************
2	#
3	# VR Juggler is (C) Copyright 1998-2005 by Iowa State University
4	#
5	# Original Authors:
6	# Allen Bierbaum, Christopher Just,
7	# Patrick Hartling, Kevin Meinert,
8	# Carolina Cruz-Neira, Albert Baker
9	#
10	# This library is free software; you can redistribute it and/or
11	# modify it under the terms of the GNU Library General Public
12	# License as published by the Free Software Foundation; either
13	# version 2 of the License, or (at your option) any later version.
14	#
15	# This library is distributed in the hope that it will be useful,
16	# but WITHOUT ANY WARRANTY; without even the implied warranty of
17	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18	# Library General Public License for more details.
19	#
20	# You should have received a copy of the GNU Library General Public
21	# License along with this library; if not, write to the
22	# Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23	# Boston, MA 02111-1307, USA.
24	#
25	# -----------------------------------------------------------------
26	# File: $RCSfile$
27	# Date modified: $Date$
28	# Version: $Revision$
29	# -----------------------------------------------------------------
30	#
31	# ************* <auto-copyright.pl END do not edit this line> *************
32
33	# =============================================================================
34	# This file is used only for generating and installing documentation. The
35	# variable $(webroot) should be assigned an appropriate value in order for
36	# an installation to work correctly.
37	#
38	# The following environment variables must be set to be able to build all the
39	# documentation:
40	#
41	# DOCBOOK_ROOT - The directory containing the DocBook XSL stylesheets and
42	# the tools needed to render DocBook documents (Batik,
43	# FOP, Saxon, and Xalan-J). This may be set as a "build
44	# variable" using a command line argumen to make(1).
45	# JAVA_HOME - The root directory of the Java runtime installation.
46	# TWEEK_BASE_DIR - The root directory of a Tweek Java API installation
47	# (using <buildir>/instlinks works fine).
48	# JCCL_BASE_DIR - The root directory of a JCCL Java API installation
49	# (using <buildir>/instlinks works fine).
50	#
51	# Furthermore, the 'doxygen' command must be in the user's path, and it is
52	# generally best if the Graphviz tools are also in the user's path.
53	#
54	# NOTE: At present, building the Java API references for JCCL and VRJConfig is
55	# rather a pain. The javadoc command needs to be able to download information
56	# from www.vrjuggler.org for the Tweek and JCCL Java APIs to generate fully
57	# hyperlinked content, but the automated documentation rendering process
58	# complicates this. In some cases, it may be necessary to render the Tweek Java
59	# API documentation & upload it and then render the JCCL Java API documentation
60	# & upload it. At that point, it is then possible to render all the Java API
61	# documentation using the automated process. Ugh.
62	# -----------------------------------------------------------------------------
63	# This makefile requires the use of GNU make.
64	# =============================================================================
65
66	# ****** Fill these in!! ******
67	webroot= $(HOME)/public_html/jugglerweb
68	distroot= $(HOME)/vrj-docs.dist
69	# *********************************
70
71	SUBDIR= doc/build.system \
72	modules/gadgeteer/doc \
73	modules/gadgeteer/doc/device.driver.guide \
74	modules/jackal/doc \
75	modules/sonix/doc \
76	modules/tweek/doc \
77	modules/tweek/doc/programmer.guide \
78	modules/vapor/doc \
79	modules/vapor/doc/programmer.guide \
80	modules/vrjuggler/doc/doxy \
81	modules/vrjuggler/doc/getting.started.guide \
82	modules/vrjuggler/doc/programmer.guide
83
84	JAVADOC_SUBDIR= modules/tweek/java \
85	modules/jackal \
86	modules/vrjuggler/vrjconfig
87
88	all:
89	ifndef TWEEK_BASE_DIR
90	$(warning TWEEK_BASE_DIR is not set)
91	endif
92	ifndef JCCL_BASE_DIR
93	$(warning JCCL_BASE_DIR is not set)
94	endif
95	@for dir in $(SUBDIR) ; do \
96	echo "===> $$dir" ; \
97	$(MAKE) -C $$dir docs \|\| exit 1; \
98	echo "<=== $$dir" ; \
99	done
100	@for dir in $(JAVADOC_SUBDIR) ; do \
101	echo "===> $$dir" ; \
102	$(MAKE) -C $$dir -f Makefile.docs docs \|\| exit 1; \
103	echo "<=== $$dir" ; \
104	done
105
106	install:
107	@for dir in $(SUBDIR) ; do \
108	echo "===> $$dir" ; \
109	$(MAKE) -C $$dir webroot=$(webroot) install-docs \|\| exit 1; \
110	echo "<=== $$dir" ; \
111	done
112	@for dir in $(JAVADOC_SUBDIR) ; do \
113	echo "===> $$dir" ; \
114	$(MAKE) -C $$dir -f Makefile.docs install-docs \|\| exit 1; \
115	echo "<=== $$dir" ; \
116	done
117
118	.PHONY: release
119
120	release:
121	-[ ! -d "$(distroot)" ] && mkdir -p "$(distroot)"
122	cp doc/dist/index.html "$(distroot)/"
123	cp "$(webroot)/base_style.css" "$(distroot)/"
124	$(MAKE) -f Makefile.docs webroot="$(distroot)" install
125
126	clobber:
127	@for dir in $(SUBDIR) ; do \
128	echo "===> $$dir" ; \
129	$(MAKE) -C $$dir clobber \|\| exit 1; \
130	echo "<=== $$dir" ; \
131	done
132	for dir in $(JAVADOC_SUBDIR) ; do \
133	echo "===> $$dir" ; \
134	$(MAKE) -C $$dir -f Makefile.docs clobber \|\| exit 1; \
135	echo "<=== $$dir" ; \
136	done

Note: See TracBrowser for help on using the browser.

Download in other formats:

Original Format