source: trunk/doc/Makefile.am

Last change on this file was 4019, checked in by Peter, 22 months ago

merge 0.18 into trunk

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.1 KB
Line 
1## $Id: Makefile.am 4019 2020-11-06 01:55:37Z peter $
2
3# Copyright (C) 2003 Jari Häkkinen
4# Copyright (C) 2005 Peter Johansson
5# Copyright (C) 2006, 2007, 2008 Jari Häkkinen, Peter Johansson
6# Copyright (C) 2009, 2010, 2011, 2012, 2020 Peter Johansson
7#
8# This file is part of the yat library, http://dev.thep.lu.se/yat
9#
10# The yat library is free software; you can redistribute it and/or
11# modify it under the terms of the GNU General Public License as
12# published by the Free Software Foundation; either version 3 of the
13# License, or (at your option) any later version.
14#
15# The yat 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# General Public License for more details.
19#
20# You should have received a copy of the GNU General Public License
21# along with yat. If not, see <http://www.gnu.org/licenses/>.
22
23
24DOXYGEN_FILES = $(srcdir)/doc/build_tool.doxygen \
25$(srcdir)/doc/deprecated.doxygen \
26$(srcdir)/doc/footer.html \
27$(srcdir)/doc/namespaces.doxygen \
28$(srcdir)/doc/concepts.doxygen \
29$(srcdir)/doc/Statistics.doxygen
30
31EXTRA_DIST += $(DOXYGEN_FILES)
32
33DOXYGEN_INPUT += $(DOXYGEN_FILES)
34DOXYGEN_INPUT += $(nobase_include_HEADERS)
35DOXYGEN_INPUT += $(nobase_nodist_include_HEADERS)
36DOXYGEN_INPUT += $(builddir)/doc/first_page.doxygen
37
38DOXYGEN_DEPS = $(DOXYGEN_INPUT) doc/doxygen.config
39
40doc: html
41
42if DX_ENABLE_HTML
43html-local: doc/html/index.html
44INSTALL_CHECK_TARGETS += installcheck-html
45endif
46
47EXTRA_DIST += doc/doxygen.config.in
48
49# config file needs to be updated when $(DOXYGEN_INPUT) is
50# changed. That variable is set in various Makefile.am, but instead we
51# depend on Makefile.in, since that dependency is easier to maintain.
52doc/doxygen.config: doc/doxygen.config.in $(srcdir)/Makefile.in
53  $(AM_V_GEN)echo "# $@ generated by make from doc/doxygen.config.in." \
54  > $@-t \
55  && $(edit) '$(srcdir)/doc/doxygen.config.in' >> $@-t \
56  && echo "INPUT = $(DOXYGEN_INPUT)" >> $@-t \
57  && mv $@-t $@
58
59doc/html/index.html: $(DOXYGEN_DEPS)
60  $(AM_V_GEN)$(DOXYGEN) doc/doxygen.config $(yat_dev_null)
61
62
63install-data-hook: install-html
64
65installdirs-local:
66  test -z "$(DESTDIR)$(htmldir)" || $(MKDIR_P) "$(DESTDIR)$(htmldir)";
67
68# local install rules does not generate any documentation, in order to
69# follow the recommendation in GCS that `make install' should not
70# modify/create anything in builddir, proved `make all' has just been
71# done. This is for the common case that `make all' is issued as one
72# user and `make install' is issued as, for example, superuser.
73
74install-html-local:
75  @$(NORMAL_INSTALL)
76  @if test -d doc/html; then \
77    test -z "$(DESTDIR)$(htmldir)" || \
78    { $(MKDIR_P) "$(DESTDIR)$(htmldir)"; \
79      $(INSTALL_DATA) doc/html/* $(DESTDIR)$(htmldir); \
80    } \
81  fi
82
83uninstall-local:
84  @$(NORMAL_UNINSTALL)
85  rm -rf $(DESTDIR)$(htmldir)
86
87# check that html has been installed (only activated when DX_ENABLE_HTML)
88## see ticket #721
89installcheck-html:
90  $(AM_V_at) test -r "$(DESTDIR)/$(htmldir)/index.html" \
91  || { echo "no documentation installed" 1>&2; exit 1; }
92
93MOSTLYCLEANFILES += doc/doxygen.config
94MOSTLYCLEANFILES += doc/doxygen.error
Note: See TracBrowser for help on using the repository browser.