docs/reference/Makefile.am

   1 # FileManager-Actions
   2 # A file-manager extension which offers configurable context menu actions.
   3 #
   4 # Copyright (C) 2005 The GNOME Foundation
   5 # Copyright (C) 2006-2008 Frederic Ruaudel and others (see AUTHORS)
   6 # Copyright (C) 2009-2015 Pierre Wieser and others (see AUTHORS)
   7 #
   8 # FileManager-Actions is free software; you can redistribute it and/or
   9 # modify it under the terms of the GNU General Public License as
  10 # published by the Free Software Foundation; either version 2 of
  11 # the License, or (at your option) any later version.
  12 #
  13 # FileManager-Actions is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16 # General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with FileManager-Actions; see the file COPYING. If not, see
  20 # <http://www.gnu.org/licenses/>.
  21 #
  22 # Authors:
  23 #   Frederic Ruaudel <grumz@grumz.net>
  24 #   Rodrigo Moya <rodrigo@gnome-db.org>
  25 #   Pierre Wieser <pwieser@trychlos.org>
  26 #   ... and many others (see AUTHORS)
  27 #
  28 # pwi 2015- 9-17 gtk-doc
  29 # --enable-gtk-doc
  30 #   doesn't build anything if neither --enable-gtk-doc-html nor
  31 #   --enable-gtk-doc-pdf is set
  32 # --enable-gtk-doc-html
  33 #   is only considered if --enable-gtk-doc is also set
  34 #   builds html/ and xml/ subdirectories
  35 #   installs html/ subdir only in DESTDIR/share/gtk-doc/html/filemanager-actions-3
  36 #   (xml/ subdir doesn't seem to be used)
  37 # --enable-gtk-doc-pdf:
  38 #   uses gtkdoc-mkpdf
  39 #   requires dblatex or fop
  40 #   doesn't work for now (see below)
  41 #
  42 # pwi 2015- 9-17 gtk-doc-1.24-1.fc22.noarch
  43 # It seems that gtkdoc-mkpdf, which may use dblatex or fop, is actually
  44 # unable to build any pdf document as the corresponding variables are
  45 # unset in the script.
  46 # These variables are unset as if the package had been built without
  47 # the corresponding utilities be available on the package build system.
  48
  49 #
  50 # FileManager-Actions Reference Manual
  51 #
  52
  53 # This includes the standard gtk-doc make rules, copied by gtkdocize.
  54 include $(top_srcdir)/gtk-doc.make
  55
  56 DOC_MODULE = filemanager-actions
  57
  58 DOC_MODULE_VERSION = 3
  59
  60 DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
  61
  62 # from the public API documentation point of view
  63 # we have to ignore all headers in src/core, and all corresponding source
  64 # that is, only consider in src/core .c sources whose header is in src/api
  65 core_headers = $(patsubst $(top_srcdir)/src/core/%,%,$(shell \ls -1 $(top_srcdir)/src/core/*.h))
  66
  67 #written_xmls_regexp = $(shell echo "$(DOC_MAIN_SGML_FILE) $(content_files)" | $(SED) 's/[[:space:]]\+/|/g')
  68 #written_xmls_regexp = $(shell echo "$(DOC_MAIN_SGML_FILE) $(auto_created_files)" | $(SED) 's/[[:space:]]\+/|/g')
  69 #written_xmls = $(shell \ls -1 *.xml | $(EGREP) -v "$(written_xmls_regexp)")
  70
  71 # content_files must include auto created ones because content_files is
  72 # a prerequisite of html-build-stamp and pdf-build-stamp targets;
  73 # we so are sure that these will be actually generated (version.xml, version_dir.xml)
  74 # as a consequence, auto created files are automatically included in the tarball
  75 content_files = \
  76         $(patsubst $(abs_srcdir)/%,%,$(shell \ls -1 $(abs_srcdir)/*.xml)) \
  77         $(auto_created_files)
  78
  79 if !HAVE_GCONF
  80 ignore_headers = fma-gconf-monitor.h
  81 else
  82 if !ENABLE_DEPRECATED
  83 ignore_headers = fma-gconf-monitor.h
  84 endif
  85 endif
  86
  87 # Extra options to supply to gtkdoc-scan
  88 #       --ignore-headers="config.h devkit-disks-daemon-glue.h"
  89 #       --rebuild-sections
  90 SCAN_OPTIONS = \
  91         --rebuild-types                                                         \
  92         --deprecated-guards=FMA_ENABLE_DEPRECATED       \
  93         $(NULL)
  94
  95 # The directory containing the source code. Relative to $(srcdir)
  96 # Starting with gtk-doc 1.15 (which is required by configure.ac),
  97 # multiple source dirs are directly handled by gtk-doc.make
  98 DOC_SOURCE_DIR = \
  99         $(top_srcdir)/src/api                                           \
 100         $(top_srcdir)/src/core                                          \
 101         $(NULL)
 102
 103 # Headers to ignore
 104 IGNORE_HFILES = \
 105         $(core_headers)                                                         \
 106         $(ignore_headers)                                                       \
 107         $(NULL)
 108
 109 # CFLAGS and LDFLAGS for compiling scan program.
 110 # Only needed if $(DOC_MODULE).types is non-empty.
 111 AM_CPPFLAGS += \
 112         -I $(top_srcdir)/src                                            \
 113         $(NAUTILUS_ACTIONS_CFLAGS)                                      \
 114         $(NULL)
 115
 116 core_libdir = $(top_builddir)/src/core/.libs
 117
 118 AM_LDFLAGS += \
 119         $(NAUTILUS_ACTIONS_LIBS)                                        \
 120         -L$(core_libdir) -lfma-core                                     \
 121         $(NULL)
 122
 123 # Need this to be able to set ourselves GTKDOC_RUN
 124 # This is extracted from gtk-doc.make
 125 if GTK_DOC_USE_LIBTOOL
 126 override GTKDOC_RUN = \
 127         $(gtkdoc_run_prefix) $(LIBTOOL) --mode=execute
 128 else
 129 override GTKDOC_RUN = \
 130         $(gtkdoc_run_prefix) sh -c
 131 endif
 132
 133 gtkdoc_run_prefix = \
 134         LD_LIBRARY_PATH=$(core_libdir)                          \
 135         $(NULL)
 136
 137 # Extra options to supply to gtkdoc-mkdb
 138 MKDB_OPTIONS = \
 139         --sgml-mode                                                             \
 140         --output-format=xml                                                     \
 141         $(NULL)
 142
 143 # Extra options to supply to gtkdoc-mktmpl
 144 MKTMPL_OPTIONS = \
 145         $(NULL)
 146
 147 # Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
 148 # nb: unable to subst/strip/sed a $(null) terminating character!
 149 #     so keep it out of there
 150 auto_created_files = \
 151         $(xml_files)                                                            \
 152         version_dir.xml
 153
 154 # Images to copy into HTML directory
 155 HTML_IMAGES = \
 156         $(NULL)
 157
 158 # Extra options to supply to gtkdoc-fixref
 159 FIXXREF_OPTIONS = \
 160         $(NULL)
 161
 162 xml_in_files = \
 163         version.xml.in                                                          \
 164         $(NULL)
 165
 166 xml_files = $(xml_in_files:.xml.in=.xml)
 167
 168 version_dir.xml: version.xml
 169         if test ! -f $@; then cat $< | $(SED) 's?^\([[:alnum:]]\.[[:alnum:]]\).*?\1?' > $@; fi
 170
 171 install-data-local: install-data-local-hook
 172
 173 install-data-local-hook:
 174
 175 .PHONY: \
 176         install-data-local-hook