source: trunk/doc/Makefile.am

## $Id: Makefile.am 4359 2023-08-23 01:28:46Z peter $

# Copyright (C) 2003 Jari Häkkinen
# Copyright (C) 2005 Peter Johansson
# Copyright (C) 2006 Jari Häkkinen, Peter Johansson
# Copyright (C) 2007 Peter Johansson
# Copyright (C) 2008 Jari Häkkinen, Peter Johansson
# Copyright (C) 2009, 2010, 2011, 2012, 2020 Peter Johansson
#
# This file is part of the yat library, http://dev.thep.lu.se/yat
#
# The yat library is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 3 of the
# License, or (at your option) any later version.
#
# The yat library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with yat. If not, see <http://www.gnu.org/licenses/>.


DOXYGEN_FILES = $(srcdir)/doc/build_tool.doxygen \
$(srcdir)/doc/deprecated.doxygen \
$(srcdir)/doc/footer.html \
$(srcdir)/doc/namespaces.doxygen \
$(srcdir)/doc/concepts.doxygen \
$(srcdir)/doc/Statistics.doxygen

EXTRA_DIST += $(DOXYGEN_FILES)

DOXYGEN_INPUT += $(DOXYGEN_FILES)
DOXYGEN_INPUT += $(nobase_include_HEADERS)
DOXYGEN_INPUT += $(nobase_nodist_include_HEADERS)
DOXYGEN_INPUT += $(builddir)/doc/first_page.doxygen

DOXYGEN_DEPS = $(DOXYGEN_INPUT) doc/doxygen.config

doc: html

if DX_ENABLE_HTML
html-local: doc/html/index.html
INSTALL_CHECK_TARGETS += installcheck-html
endif

EXTRA_DIST += doc/doxygen.config.in

# config file needs to be updated when $(DOXYGEN_INPUT) is
# changed. That variable is set in various Makefile.am, but instead we
# depend on Makefile.in, since that dependency is easier to maintain.
doc/doxygen.config: doc/doxygen.config.in $(srcdir)/Makefile.in
  $(AM_V_GEN)echo "# $@ generated by make from doc/doxygen.config.in." \
  > $@-t \
  && $(edit) '$(srcdir)/doc/doxygen.config.in' >> $@-t \
  && echo "INPUT = $(DOXYGEN_INPUT)" >> $@-t \
  && mv $@-t $@

doc/html/index.html: $(DOXYGEN_DEPS)
  $(AM_V_GEN)$(DOXYGEN) doc/doxygen.config $(yat_dev_null)


install-data-hook: install-html

installdirs-local:
  test -z "$(DESTDIR)$(htmldir)" || $(MKDIR_P) "$(DESTDIR)$(htmldir)";

# local install rules does not generate any documentation, in order to
# follow the recommendation in GCS that `make install' should not
# modify/create anything in builddir, proved `make all' has just been
# done. This is for the common case that `make all' is issued as one
# user and `make install' is issued as, for example, superuser.

install-html-local:
  @$(NORMAL_INSTALL)
  @if test -d doc/html; then \
    test -z "$(DESTDIR)$(htmldir)" || \
    { $(MKDIR_P) "$(DESTDIR)$(htmldir)"; \
      $(INSTALL_DATA) doc/html/* $(DESTDIR)$(htmldir); \
    } \
  fi

uninstall-local:
  @$(NORMAL_UNINSTALL)
  rm -rf $(DESTDIR)$(htmldir)

# check that html has been installed (only activated when DX_ENABLE_HTML)
## see ticket #721
installcheck-html:
  $(AM_V_at) test -r "$(DESTDIR)/$(htmldir)/index.html" \
  || { echo "no documentation installed" 1>&2; exit 1; }

MOSTLYCLEANFILES += doc/doxygen.config
MOSTLYCLEANFILES += doc/doxygen.error