Commit 1ac53274 authored by Karl Wette's avatar Karl Wette

lal/doxygen/Makefile.am: build documentation from distribution directory

- Ensures only distributed files are included in documentation
- Building distribution directory will also build generated files
Original: 88a88c0a0d368e6b65f161f940d2fdfc9660029f
parent 0c2f8176
......@@ -33,18 +33,20 @@ $(PACKAGE)rc: Makefile
if DOXYGEN
html-local: Makefile $(CONFIG_CLEAN_FILES)
$(AM_V_at)echo "=== Doxygen documentation was built successfully!"; \
echo "=== $(PACKAGE_NAME) main page is at file://$(abs_builddir)/index.html"
$(AM_V_at)set -e; \
echo "$(subdir)/Makefile: Doxygen documentation was built successfully!"; \
echo "$(subdir)/Makefile: $(PACKAGE_NAME) main page is at file://$(abs_builddir)/index.html"
install-html-local: html-local
$(AM_V_at)echo " $(MKDIR_P) '$(DESTDIR)$(htmldir)'"; \
$(MKDIR_P) "$(DESTDIR)$(htmldir)" || exit 1; \
$(AM_V_at)set -e; \
echo " $(MKDIR_P) '$(DESTDIR)$(htmldir)'"; \
$(MKDIR_P) "$(DESTDIR)$(htmldir)"; \
echo " $(INSTALL_DATA) index.html '$(DESTDIR)$(htmldir)/index.html'"; \
$(SED) -e 's|\(lal[a-z]*\)/doxygen/out|../\1|g' index.html > $@.tmp || exit 1; \
$(INSTALL_DATA) $@.tmp "$(DESTDIR)$(htmldir)/index.html" || exit 1; \
$(SED) -e 's|\(lal[a-z]*\)/doxygen/out|../\1|g' index.html > $@.tmp; \
$(INSTALL_DATA) $@.tmp "$(DESTDIR)$(htmldir)/index.html"; \
rm -f $@.tmp; \
echo "=== Doxygen documentation was installed successfully!"; \
echo "=== Installed $(PACKAGE_NAME) main page is at file://$(DESTDIR)$(htmldir)/index.html"
echo "$(subdir)/Makefile: Doxygen documentation was installed successfully!"; \
echo "$(subdir)/Makefile: installed $(PACKAGE_NAME) main page is at file://$(DESTDIR)$(htmldir)/index.html"
uninstall-local:
-rm -rf "$(DESTDIR)$(htmldir)/"
......
......@@ -20,7 +20,10 @@ Makefile.in
config.lt
doxygen/autogen.dox
doxygen/doxygen.cfg
doxygen/doxygen_objdb_*.tmp
doxygen/doxygen_sqlite3.db
doxygen/filter
doxygen/in/
doxygen/out/
doxygen/test_doxygen.*
include/lal/*.h
......
......@@ -18,7 +18,14 @@ doxygen_redir_0 = >/dev/null
doxygen_redir_1 =
html-local: Makefile $(CONFIG_CLEAN_FILES)
$(AM_V_at)export doxygen_version="$(VERSION)"; \
$(AM_V_at)set -e; \
echo "$(subdir)/Makefile: getting input sources ..."; \
( cd $(top_builddir) && make V=$(V) distdir $(doxygen_redir) ); \
rm -rf in/; \
mv "$(top_builddir)/$(PACKAGE)-$(VERSION)/" in/; \
rm -rf in/doxygen/; \
echo "$(subdir)/Makefile: configuring Doxygen build ..."; \
export doxygen_version="$(VERSION)"; \
if test "x$(doxygen_include_gitid)" = xtrue; then \
gitid=`cd $(abs_top_srcdir) && $(GIT) log -1 --pretty='format:%h'`; \
if test "x$${gitid}" != x; then \
......@@ -28,79 +35,53 @@ html-local: Makefile $(CONFIG_CLEAN_FILES)
fi; \
export doxygen_tagfiles; doxygen_tagfiles="$(DOXYGEN_TAGFILES)"; \
export doxygen_quiet; doxygen_quiet="$(doxygen_quiet)"; \
export doxygen_input; doxygen_input=; \
for dir in src test python; do \
test -d "$(abs_top_srcdir)/$${dir}" && doxygen_input="$${doxygen_input} $(abs_top_srcdir)/$${dir}"; \
done; \
files="\
$(abs_top_builddir)/src/$(PACKAGE_NAME)VCSInfo.h \
$(abs_top_builddir)/src/$(PACKAGE_NAME)VCSInfo.c \
$(abs_top_builddir)/src/$(PACKAGE_NAME_LCASE)/$(PACKAGE_NAME)VCSInfo.h \
$(abs_top_builddir)/src/$(PACKAGE_NAME_LCASE)/$(PACKAGE_NAME)VCSInfo.c \
$(abs_top_srcdir)/swig/SWIGCommon.i \
$(abs_top_srcdir)/swig/SWIG$(PACKAGE_NAME)Alpha.i \
$(abs_top_srcdir)/swig/SWIG$(PACKAGE_NAME)Omega.i \
"; \
for file in $${files}; do \
test -r "$${file}" && doxygen_input="$${doxygen_input} $${file}"; \
done; \
test -r "$(abs_srcdir)/exclude.list" || exit 1; \
export doxygen_exclude; doxygen_exclude=`cat $(abs_srcdir)/exclude.list | tr '\n' ' '`; \
echo '/* Generated by $(subdir)/Makefile */' > autogen.dox; \
echo '/** \mainpage' >> autogen.dox; \
test -r "$(abs_top_srcdir)/README" || exit 1; \
cat $(abs_top_srcdir)/README >> autogen.dox; \
cat in/README >> autogen.dox; \
echo '*/' >> autogen.dox; \
echo '/** \page $(PACKAGE)_authors Author List' >> autogen.dox; \
( cd $(abs_top_builddir) && $(MAKE) $(AM_MAKEFLAGS) AUTHORS ) || exit 1; \
if test -f "$(abs_top_builddir)/AUTHORS"; then \
doxygen_authors="$(abs_top_builddir)/AUTHORS"; \
elif test -f "$(abs_top_srcdir)/AUTHORS"; then \
doxygen_authors="$(abs_top_srcdir)/AUTHORS"; \
else \
echo "$(srcdir)/Makefile: Could not find AUTHORS" >&2; \
exit 1; \
fi; \
$(SED) -e 's/^/- /' $${doxygen_authors} >> autogen.dox; \
$(SED) -e 's/^/- /' in/AUTHORS >> autogen.dox; \
echo '*/' >> autogen.dox; \
$(MKDIR_P) out/ || exit 1; \
echo "=== Building Doxygen documentation for $(PACKAGE_NAME)..."; \
echo "$(subdir)/Makefile: building Doxygen documentation ..."; \
$(MKDIR_P) out/; \
$(DOXYGEN) doxygen.cfg $(doxygen_redir) 2>&1; \
$(PYTHON) $(abs_srcdir)/check_tags.py $(abs_builddir)/out/$(PACKAGE).tag >> warnings.log || exit 1; \
$(PYTHON) $(abs_srcdir)/check_tags.py $(abs_builddir)/out/$(PACKAGE).tag >> warnings.log; \
$(SED) $(DOXYGEN_WARNING_REGEX) warnings.log > errors.log; \
cat errors.log >&2 || exit 1; \
test `cat errors.log | wc -l` -eq 0 || exit 1; \
rm -f doxygen_objdb_*.tmp doxygen_sqlite3.db; \
echo "=== Doxygen documentation was built successfully!"; \
echo "=== $(PACKAGE_NAME) main page is at file://$(abs_builddir)/out/index.html"
cat errors.log >&2; \
test `cat errors.log | wc -l` -eq 0; \
rm -rf in/; \
echo "$(subdir)/Makefile: Doxygen documentation was built successfully!"; \
echo "$(subdir)/Makefile: $(PACKAGE_NAME) main page is at file://$(abs_builddir)/out/index.html"
TESTS = test_doxygen.sh
test_doxygen.sh:
$(AM_V_at)echo "cd $(abs_builddir) && make html" >$@
install-html-local: html-local
$(AM_V_at)for dir in `cd out/ && find . -type d`; do \
$(AM_V_at)set -e; \
for dir in `cd out/ && find . -type d`; do \
echo " $(MKDIR_P) '$(DESTDIR)$(htmldir)/$${dir}'"; \
$(MKDIR_P) "$(DESTDIR)$(htmldir)/$${dir}" || exit 1; \
$(PYTHON) $(abs_srcdir)/install_regex.py "$(DESTDIR)$(htmldir)/$${dir}" "$(DOXYGEN_INSTALL_DIRMAP)" > $@.regex || exit 1; \
$(MKDIR_P) "$(DESTDIR)$(htmldir)/$${dir}"; \
$(PYTHON) $(abs_srcdir)/install_regex.py "$(DESTDIR)$(htmldir)/$${dir}" "$(DOXYGEN_INSTALL_DIRMAP)" > $@.regex; \
for file in `cd out/ && echo $${dir}/*`; do \
if test -f "out/$${file}"; then \
echo " $(INSTALL_DATA) out/$${file} '$(DESTDIR)$(htmldir)/$${file}'"; \
$(SED) -n -f $@.regex "out/$${file}" > $@.tmp || exit 1; \
$(INSTALL_DATA) $@.tmp "$(DESTDIR)$(htmldir)/$${file}" || exit 1; \
$(SED) -n -f $@.regex "out/$${file}" > $@.tmp; \
$(INSTALL_DATA) $@.tmp "$(DESTDIR)$(htmldir)/$${file}"; \
fi; \
done; \
done; \
rm -f $@.regex $@.tmp; \
echo "=== Doxygen documentation was installed successfully!"; \
echo "=== Installed $(PACKAGE_NAME) main page is at file://$(DESTDIR)$(htmldir)/index.html"
echo "$(subdir)/Makefile: Doxygen documentation was installed successfully!"; \
echo "$(subdir)/Makefile: installed $(PACKAGE_NAME) main page is at file://$(DESTDIR)$(htmldir)/index.html"
uninstall-local:
-rm -rf "$(DESTDIR)$(htmldir)/"
clean-local:
-rm -rf out/
-rm -f autogen.dox errors.log warnings.log test_doxygen.sh
-rm -rf in/ out/
-rm -f autogen.dox doxygen_objdb_*.tmp doxygen_sqlite3.db errors.log warnings.log test_doxygen.sh
EXTRA_DIST = \
check_tags.py \
......@@ -112,7 +93,6 @@ EXTRA_DIST = \
mathjax.js \
src \
stylesheet.css \
toplevel.dox \
$(END_OF_LIST)
endif # DOXYGEN
......@@ -152,7 +152,7 @@ FULL_PATH_NAMES = NO
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
STRIP_FROM_PATH = @abs_top_srcdir@
STRIP_FROM_PATH = @abs_builddir@/in
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
......@@ -760,8 +760,8 @@ WARN_LOGFILE = @abs_builddir@/warnings.log
# Note: If this tag is empty the current directory is searched.
INPUT = @abs_builddir@/autogen.dox \
@abs_srcdir@/toplevel.dox \
$(doxygen_input)
@abs_srcdir@/src/toplevel.dox \
@abs_builddir@/in
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
......@@ -784,7 +784,8 @@ INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.c \
*.h \
*.py \
*.dox
*.dox \
SWIG*.i
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
......@@ -855,7 +856,7 @@ EXAMPLE_RECURSIVE = NO
# \image command).
IMAGE_PATH = @abs_srcdir@/src \
$(doxygen_input)
@abs_builddir@/in
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
......
......@@ -16,7 +16,10 @@ Makefile.in
config.lt
doxygen/autogen.dox
doxygen/doxygen.cfg
doxygen/doxygen_objdb_*.tmp
doxygen/doxygen_sqlite3.db
doxygen/filter
doxygen/in/
doxygen/out/
doxygen/test_doxygen.*
lalapps-*.tar.xz
......
*/src/pulsar/PowerFlux/cmdline.[ch]
*/src/pulsar/loosely_coherent/cmdline.[ch]
*/src/tracksearch/FrameDataConvert_source.c
......@@ -43,7 +43,7 @@ information on <tt>lalapps_stopp</tt>.
In order to create the DAG, a configuration file is required, examples
of which can be found in the <tt>lalapps/src/stochastic/example</tt>
directory. This configuration specfies the parameters to use for each
step of the pipeline. See \ref lalapps_stochastic_pipe.py
step of the pipeline. See <tt>lalapps_stochastic_pipe</tt>
for details regarding the layout of the configuration file.
Any combination of nodes, see above, can be present in the DAG, assuming
......
......@@ -16,7 +16,10 @@ Makefile.in
config.lt
doxygen/autogen.dox
doxygen/doxygen.cfg
doxygen/doxygen_objdb_*.tmp
doxygen/doxygen_sqlite3.db
doxygen/filter
doxygen/in/
doxygen/out/
doxygen/test_doxygen.*
include/lal/*.h
......
......@@ -16,7 +16,10 @@ Makefile.in
config.lt
doxygen/autogen.dox
doxygen/doxygen.cfg
doxygen/doxygen_objdb_*.tmp
doxygen/doxygen_sqlite3.db
doxygen/filter
doxygen/in/
doxygen/out/
doxygen/test_doxygen.*
include/lal/*.h
......
......@@ -16,7 +16,10 @@ Makefile.in
config.lt
doxygen/autogen.dox
doxygen/doxygen.cfg
doxygen/doxygen_objdb_*.tmp
doxygen/doxygen_sqlite3.db
doxygen/filter
doxygen/in/
doxygen/out/
doxygen/test_doxygen.*
include/lal/*.h
......
......@@ -16,7 +16,10 @@ Makefile.in
config.lt
doxygen/autogen.dox
doxygen/doxygen.cfg
doxygen/doxygen_objdb_*.tmp
doxygen/doxygen_sqlite3.db
doxygen/filter
doxygen/in/
doxygen/out/
doxygen/test_doxygen.*
include/lal/*.h
......
......@@ -16,7 +16,10 @@ Makefile.in
config.lt
doxygen/autogen.dox
doxygen/doxygen.cfg
doxygen/doxygen_objdb_*.tmp
doxygen/doxygen_sqlite3.db
doxygen/filter
doxygen/in/
doxygen/out/
doxygen/test_doxygen.*
include/lal/*.h
......
......@@ -16,7 +16,10 @@ Makefile.in
config.lt
doxygen/autogen.dox
doxygen/doxygen.cfg
doxygen/doxygen_objdb_*.tmp
doxygen/doxygen_sqlite3.db
doxygen/filter
doxygen/in/
doxygen/out/
doxygen/test_doxygen.*
include/lal/*.h
......
......@@ -16,7 +16,10 @@ Makefile.in
config.lt
doxygen/autogen.dox
doxygen/doxygen.cfg
doxygen/doxygen_objdb_*.tmp
doxygen/doxygen_sqlite3.db
doxygen/filter
doxygen/in/
doxygen/out/
doxygen/test_doxygen.*
include/lal/*.h
......
......@@ -16,7 +16,10 @@ Makefile.in
config.lt
doxygen/autogen.dox
doxygen/doxygen.cfg
doxygen/doxygen_objdb_*.tmp
doxygen/doxygen_sqlite3.db
doxygen/filter
doxygen/in/
doxygen/out/
doxygen/test_doxygen.*
include/lal/*.h
......
......@@ -16,7 +16,10 @@ Makefile.in
config.lt
doxygen/autogen.dox
doxygen/doxygen.cfg
doxygen/doxygen_objdb_*.tmp
doxygen/doxygen_sqlite3.db
doxygen/filter
doxygen/in/
doxygen/out/
doxygen/test_doxygen.*
include/lal/*.h
......
......@@ -16,7 +16,10 @@ Makefile.in
config.lt
doxygen/autogen.dox
doxygen/doxygen.cfg
doxygen/doxygen_objdb_*.tmp
doxygen/doxygen_sqlite3.db
doxygen/filter
doxygen/in/
doxygen/out/
doxygen/test_doxygen.*
include/lal/*.h
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment