doc/Makefile.am

   1 man_MANS=geany.1
   2
   3 if INSTALL_HTML_DOCS
   4 htmldocimagesdir = $(docdir)/html/images
   5 dist_htmldocimages_DATA = \
   6         images/build_menu_commands_dialog.png \
   7         images/find_dialog.png \
   8         images/find_in_files_dialog.png \
   9         images/main_window.png \
  10         images/pref_dialog_edit_completions.png \
  11         images/pref_dialog_edit_display.png \
  12         images/pref_dialog_edit_features.png \
  13         images/pref_dialog_edit_indentation.png \
  14         images/pref_dialog_files.png \
  15         images/pref_dialog_gen_misc.png \
  16         images/pref_dialog_gen_startup.png \
  17         images/pref_dialog_interface_interface.png \
  18         images/pref_dialog_interface_notebook.png \
  19         images/pref_dialog_interface_toolbar.png \
  20         images/pref_dialog_keys.png \
  21         images/pref_dialog_printing.png \
  22         images/pref_dialog_templ.png \
  23         images/pref_dialog_tools.png \
  24         images/pref_dialog_various.png \
  25         images/pref_dialog_vte.png \
  26         images/replace_dialog.png
  27 endif
  28
  29 doc_DATA = \
  30         $(top_srcdir)/AUTHORS \
  31         $(top_srcdir)/ChangeLog \
  32         $(top_srcdir)/COPYING \
  33         $(top_srcdir)/NEWS \
  34         $(top_srcdir)/README \
  35         $(top_srcdir)/THANKS \
  36         $(top_srcdir)/TODO
  37
  38 DOCDIR = $(DESTDIR)$(docdir)
  39
  40 EXTRA_DIST = \
  41         geany.html \
  42         geany.css \
  43         geany.txt \
  44         geany.1
  45
  46 # HTML user manual and hacking file
  47 if WITH_RST2HTML
  48
  49 geany.html: $(srcdir)/geany.css $(srcdir)/geany.txt
  50         $(AM_V_GEN)$(RST2HTML) -stg --stylesheet=$(srcdir)/geany.css $(srcdir)/geany.txt $@
  51
  52 hacking.html: $(srcdir)/geany.css $(top_srcdir)/HACKING
  53         $(AM_V_GEN)$(RST2HTML) -stg --stylesheet=$(srcdir)/geany.css $(top_srcdir)/HACKING $@
  54
  55 all-local: geany.html hacking.html
  56
  57 # clean on 'maintainer-clean' rather than 'clean' in case it was not
  58 # built by Make but rather part of the distribution.  This is fine even
  59 # then, as configure will properly require what is needed to build it
  60 # again if it is missing.
  61 maintainer-clean-local: maintainer-clean-html-local
  62 maintainer-clean-html-local:
  63         -rm -f geany.html
  64
  65 clean-local: clean-html-local
  66 clean-html-local:
  67         -rm -f hacking.html
  68
  69 endif
  70
  71 # PDF user manual
  72 if WITH_RST2PDF
  73
  74 geany-$(VERSION).pdf: geany.txt
  75         $(AM_V_GEN)$(RST2PDF) $(srcdir)/geany.txt -o $@
  76
  77 all-local: geany-$(VERSION).pdf
  78
  79 clean-local: clean-pdf-local
  80 clean-pdf-local:
  81         -rm -f geany-$(VERSION).pdf
  82
  83 endif
  84
  85 AT=@
  86
  87 # API Documentation
  88 if WITH_DOXYGEN
  89
  90 # $(AT) instead of @ so that configure doesn't mess up the rules already
  91 Doxyfile: Doxyfile.in
  92         $(AM_V_GEN)$(SED) \
  93                 -e 's,$(AT)top_srcdir$(AT),$(top_srcdir),' \
  94                 -e 's,$(AT)top_builddir$(AT),$(top_builddir),' \
  95                 -e 's,$(AT)VERSION$(AT),$(VERSION),' \
  96                 -e 's,$(AT)GIRONLY$(AT),@internal,' \
  97                 -e 's,$(AT)HTML$(AT),YES,' \
  98                 -e 's,$(AT)XML$(AT),NO,' \
  99                 -e 's,$(AT)SORT$(AT),YES,' \
 100                 $< > $@ || ( $(RM) -f $@ ; exit 1 )
 101
 102 doxygen_sources = \
 103         $(srcdir)/plugins.dox \
 104         $(srcdir)/pluginsignals.c \
 105         $(srcdir)/pluginsymbols.c \
 106         $(srcdir)/stash-example.c \
 107         $(srcdir)/stash-gui-example.c
 108
 109 EXTRA_DIST += Doxyfile.in $(doxygen_sources)
 110
 111 doxygen_dependencies = \
 112         $(doxygen_sources) \
 113         $(top_srcdir)/src/*.[ch] \
 114         $(top_srcdir)/plugins/geanyplugin.h \
 115         $(top_srcdir)/src/tagmanager/tm_source_file.[ch] \
 116         $(top_srcdir)/src/tagmanager/tm_workspace.[ch] \
 117         $(top_srcdir)/src/tagmanager/tm_tag.h \
 118         $(top_srcdir)/src/tagmanager/tm_parser.h
 119
 120 Doxyfile.stamp: Doxyfile $(doxygen_dependencies)
 121         $(AM_V_GEN)$(DOXYGEN) Doxyfile && echo "" > $@
 122
 123 ALL_LOCAL_TARGETS = Doxyfile.stamp
 124 CLEAN_LOCAL_TARGETS = clean-api-docs-local
 125
 126 clean-api-docs-local:
 127         -rm -rf reference/ Doxyfile.stamp doxygen_*
 128
 129 if ENABLE_GTKDOC_HEADER
 130
 131 Doxyfile-gi: Doxyfile.in
 132         $(AM_V_GEN)$(SED) \
 133                 -e 's,$(AT)top_srcdir$(AT),$(top_srcdir),' \
 134                 -e 's,$(AT)top_builddir$(AT),$(top_builddir),' \
 135                 -e 's,$(AT)VERSION$(AT),$(VERSION),' \
 136                 -e 's,$(AT)GIRONLY$(AT),,' \
 137                 -e 's,$(AT)HTML$(AT),NO,' \
 138                 -e 's,$(AT)XML$(AT),YES,' \
 139                 -e 's,$(AT)SORT$(AT),NO,' \
 140                 $< > $@ || ( $(RM) -f $@ ; exit 1 )
 141
 142 # we depend on Doxyfile.stamp not have this run in parallel with it to avoid
 143 # concurrent Doxygen runs, which might overwrite each other's files
 144 Doxyfile-gi.stamp: Doxyfile-gi Doxyfile.stamp $(doxygen_dependencies)
 145         $(AM_V_GEN)$(DOXYGEN) Doxyfile-gi && echo "" > $@
 146
 147 geany-gtkdoc.h: Doxyfile-gi.stamp $(top_srcdir)/scripts/gen-api-gtkdoc.py
 148         $(AM_V_GEN)$(PYTHON) $(top_srcdir)/scripts/gen-api-gtkdoc.py xml -d $(builddir) -o $@ \
 149                         --sci-output geany-sciwrappers-gtkdoc.h
 150
 151 geany-sciwrappers-gtkdoc.h: geany-gtkdoc.h
 152
 153 geany_gtkdocincludedir = $(includedir)/geany/gtkdoc
 154 nodist_geany_gtkdocinclude_HEADERS = geany-gtkdoc.h geany-sciwrappers-gtkdoc.h
 155
 156 ALL_LOCAL_TARGETS += geany-gtkdoc.h geany-sciwrappers-gtkdoc.h
 157 CLEAN_LOCAL_TARGETS += clean-gtkdoc-header-local
 158
 159 clean-gtkdoc-header-local:
 160         rm -rf xml/ \
 161                 Doxyfile Doxyfile.stamp Doxyfile-gi Doxyfile-gi.stamp \
 162                 geany-gtkdoc.h geany-sciwrappers-gtkdoc.h
 163
 164 endif
 165
 166 all-local: $(ALL_LOCAL_TARGETS)
 167 clean-local: $(CLEAN_LOCAL_TARGETS)
 168
 169 endif
 170
 171 uninstall-local:
 172         rm -f $(DOCDIR)/html/index.html
 173         rm -f $(DOCDIR)/manual.txt
 174         rm -f $(DOCDIR)/ScintillaLicense.txt
 175         rm -f $(DOCDIR)/LexillaLicense.txt
 176
 177 # manually install some files under another name
 178 install-data-local:
 179 if INSTALL_HTML_DOCS
 180         $(mkinstalldirs) $(DOCDIR)/html
 181 #       as we don't install with the automated mechanism so we can rename the file,
 182 #       we need to find the source file in the right location (either builddir or srcdir)
 183         dir=$(builddir); test -f "$$dir/geany.html" || dir=$(srcdir); \
 184         $(INSTALL_DATA) "$$dir/geany.html" $(DOCDIR)/html/index.html
 185 endif
 186         $(mkinstalldirs) $(DOCDIR)
 187         $(INSTALL_DATA) $(srcdir)/geany.txt $(DOCDIR)/manual.txt
 188         $(INSTALL_DATA) $(top_srcdir)/scintilla/License.txt $(DOCDIR)/ScintillaLicense.txt
 189         $(INSTALL_DATA) $(top_srcdir)/scintilla/lexilla/License.txt $(DOCDIR)/LexillaLicense.txt