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