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         plugins.dox \
  46         pluginsymbols.c \
  47         pluginsignals.c \
  48         stash-example.c \
  49         stash-gui-example.c \
  50         makefile.win32
  51
  52 # HTML user manual and hacking file
  53 if WITH_RST2HTML
  54
  55 geany.html: $(srcdir)/geany.css $(srcdir)/geany.txt
  56         $(AM_V_GEN)$(RST2HTML) -stg --stylesheet=$(srcdir)/geany.css $(srcdir)/geany.txt $@
  57
  58 hacking.html: $(srcdir)/geany.css $(top_srcdir)/HACKING
  59         $(AM_V_GEN)$(RST2HTML) -stg --stylesheet=$(srcdir)/geany.css $(top_srcdir)/HACKING $@
  60
  61 all-local: geany.html hacking.html
  62
  63 # clean on 'maintainer-clean' rather than 'clean' in case it was not
  64 # built by Make but rather part of the distribution.  This is fine even
  65 # then, as configure will properly require what is needed to build it
  66 # again if it is missing.
  67 maintainer-clean-local: maintainer-clean-html-local
  68 maintainer-clean-html-local:
  69         -rm -f geany.html
  70
  71 clean-local: clean-html-local
  72 clean-html-local:
  73         -rm -f hacking.html
  74
  75 endif
  76
  77 # PDF user manual
  78 if WITH_RST2PDF
  79
  80 geany-$(VERSION).pdf: geany.txt
  81         $(AM_V_GEN)$(RST2PDF) $(srcdir)/geany.txt -o $@
  82
  83 all-local: geany-$(VERSION).pdf
  84
  85 clean-local: clean-pdf-local
  86 clean-pdf-local:
  87         -rm -f geany-$(VERSION).pdf
  88
  89 endif
  90
  91 # API Documentation
  92 if WITH_DOXYGEN
  93
  94 doxygen_sources = \
  95         $(srcdir)/*.[ch] \
  96         $(srcdir)/*.dox \
  97         $(top_srcdir)/src/*.[ch] \
  98         $(top_srcdir)/plugins/geanyplugin.h \
  99         $(top_srcdir)/tagmanager/src/tm_source_file.[ch] \
 100         $(top_srcdir)/tagmanager/src/tm_workspace.[ch]
 101
 102 Doxyfile.stamp: Doxyfile $(doxygen_sources)
 103         $(AM_V_GEN)$(DOXYGEN) Doxyfile && echo "" > $@
 104
 105 ALL_LOCAL_TARGETS = Doxyfile.stamp
 106 CLEAN_LOCAL_TARGETS = clean-api-docs-local
 107
 108 clean-api-docs-local:
 109         -rm -rf reference/ Doxyfile.stamp doxygen_*
 110
 111 if ENABLE_GTKDOC_HEADER
 112
 113 # set WARN_IF_UNDOCUMENTED because apparently doxygens warns for undocumented stuff
 114 # in headers (even though it's correctly documented in the corresponding .c file) only
 115 # for xml output
 116 Doxyfile-gi: Doxyfile
 117         $(AM_V_GEN)$(SED) \
 118                 -e 's,gironly=@internal,gironly=,' \
 119                 -e 's,^\(GENERATE_HTML.*\)YES,\1NO,' \
 120                 -e 's,^\(GENERATE_XML.*\)NO,\1YES,' \
 121                 -e 's,^\(WARN_IF_UNDOCUMENTED.*\)YES,\1NO,' \
 122                 -e 's,^\(SORT_MEMBER_DOCS.*\)YES,\1NO,' \
 123                 -e 's,^\(SORT_BRIEF_DOCS.*\)YES,\1NO,' \
 124                 $< > $@ || { $(RM) $@ && exit 1; }
 125
 126 # we depend on Doxyfile.stamp not have this run in parallel with it to avoid
 127 # concurrent Doxygen runs, which might overwrite each other's files
 128 Doxyfile-gi.stamp: Doxyfile-gi Doxyfile.stamp $(doxygen_sources)
 129         $(AM_V_GEN)$(DOXYGEN) Doxyfile-gi && echo "" > $@
 130
 131 geany-gtkdoc.h: Doxyfile-gi.stamp $(top_srcdir)/scripts/gen-api-gtkdoc.py
 132         $(AM_V_GEN)$(top_srcdir)/scripts/gen-api-gtkdoc.py xml -d $(builddir) -o $@ \
 133                         --sci-output geany-sciwrappers-gtkdoc.h
 134
 135 geany-sciwrappers-gtkdoc.h: geany-gtkdoc.h
 136
 137 geany_gtkdocincludedir = $(includedir)/geany/gtkdoc
 138 nodist_geany_gtkdocinclude_HEADERS = geany-gtkdoc.h geany-sciwrappers-gtkdoc.h
 139
 140 ALL_LOCAL_TARGETS += geany-gtkdoc.h geany-sciwrappers-gtkdoc.h
 141 CLEAN_LOCAL_TARGETS += clean-gtkdoc-header-local
 142
 143 clean-gtkdoc-header-local:
 144         -rm -rf xml/ Doxyfile-gi Doxyfile-gi.stamp geany-gtkdoc.h geany-sciwrappers-gtkdoc.h
 145
 146 endif
 147
 148 all-local: $(ALL_LOCAL_TARGETS)
 149 clean-local: $(CLEAN_LOCAL_TARGETS)
 150
 151 endif
 152
 153 uninstall-local:
 154         rm -f $(DOCDIR)/html/index.html
 155         rm -f $(DOCDIR)/manual.txt
 156         rm -f $(DOCDIR)/ScintillaLicense.txt
 157
 158 # manually install some files under another name
 159 install-data-local:
 160 if INSTALL_HTML_DOCS
 161         $(mkinstalldirs) $(DOCDIR)/html
 162 #       as we don't install with the automated mechanism so we can rename the file,
 163 #       we need to find the source file in the right location (either builddir or srcdir)
 164         dir=$(builddir); test -f "$$dir/geany.html" || dir=$(srcdir); \
 165         $(INSTALL_DATA) "$$dir/geany.html" $(DOCDIR)/html/index.html
 166 endif
 167         $(mkinstalldirs) $(DOCDIR)
 168         $(INSTALL_DATA) $(srcdir)/geany.txt $(DOCDIR)/manual.txt
 169         $(INSTALL_DATA) $(top_srcdir)/scintilla/License.txt $(DOCDIR)/ScintillaLicense.txt