Update HACKING for changed doc generation instructions
[geany-mirror.git] / doc / Makefile.am
blob06c73d2e6eb3e78201095621dfb71d340cb79a48
1 man_MANS=geany.1
3 htmldocimagesdir = $(docdir)/html/images
4 dist_htmldocimages_DATA = \
5         images/build_menu_commands_dialog.png \
6         images/find_dialog.png \
7         images/find_in_files_dialog.png \
8         images/main_window.png \
9         images/pref_dialog_edit_completions.png \
10         images/pref_dialog_edit_display.png \
11         images/pref_dialog_edit_features.png \
12         images/pref_dialog_edit_indentation.png \
13         images/pref_dialog_files.png \
14         images/pref_dialog_gen_misc.png \
15         images/pref_dialog_gen_startup.png \
16         images/pref_dialog_interface_interface.png \
17         images/pref_dialog_interface_notebook.png \
18         images/pref_dialog_interface_toolbar.png \
19         images/pref_dialog_keys.png \
20         images/pref_dialog_printing.png \
21         images/pref_dialog_templ.png \
22         images/pref_dialog_tools.png \
23         images/pref_dialog_various.png \
24         images/pref_dialog_vte.png \
25         images/replace_dialog.png
27 doc_DATA = \
28         $(top_srcdir)/AUTHORS \
29         $(top_srcdir)/ChangeLog \
30         $(top_srcdir)/COPYING \
31         $(top_srcdir)/NEWS \
32         $(top_srcdir)/README \
33         $(top_srcdir)/THANKS \
34         $(top_srcdir)/TODO
36 DOCDIR = $(DESTDIR)$(docdir)
38 EXTRA_DIST = \
39         geany.html \
40         geany.css \
41         geany.txt \
42         geany.1 \
43         plugins.dox \
44         pluginsymbols.c \
45         pluginsignals.c \
46         stash-example.c \
47         stash-gui-example.c \
48         makefile.win32
50 # HTML user manual and hacking file
51 if WITH_RST2HTML
53 geany.html: $(srcdir)/geany.css $(srcdir)/geany.txt
54         $(AM_V_GEN)$(RST2HTML) -stg --stylesheet=$(srcdir)/geany.css $(srcdir)/geany.txt $@
56 hacking.html: $(srcdir)/geany.css $(top_srcdir)/HACKING
57         $(AM_V_GEN)$(RST2HTML) -stg --stylesheet=$(srcdir)/geany.css $(top_srcdir)/HACKING $@
59 all-html-local: geany.html hacking.html
61 clean-html-local:
62         -rm -f hacking.html
63 # FIXME: why is the generated HTML manual checked-in to VCS?
64 #       -rm -f geany.html
66 else
67 all-html-local:;
68 clean-html-local:;
69 endif
71 # PDF user manual
72 if WITH_RST2PDF
74 geany-$(VERSION).pdf: geany.txt
75         $(AM_V_GEN)$(RST2PDF) $(srcdir)/geany.txt -o $@
77 all-pdf-local: geany-$(VERSION).pdf
79 clean-pdf-local:
80         -rm -f geany-$(VERSION).pdf
82 else
83 all-pdf-local:;
84 clean-pdf-local:;
85 endif
87 # API Documentation
88 if WITH_DOXYGEN
90 doxygen_sources = \
91         $(srcdir)/*.[ch] \
92         $(srcdir)/*.dox \
93         $(top_srcdir)/src/*.[ch] \
94         $(top_srcdir)/plugins/geanyplugin.h \
95         $(top_srcdir)/plugins/geanyfunctions.h \
96         $(top_srcdir)/tagmanager/src/tm_source_file.[ch] \
97         $(top_srcdir)/tagmanager/src/tm_work_object.[ch] \
98         $(top_srcdir)/tagmanager/src/tm_workspace.[ch]
100 Doxyfile.stamp: Doxyfile $(doxygen_sources)
101         $(AM_V_GEN)$(DOXYGEN) Doxyfile && echo "" > $@
103 all-api-docs-local: Doxyfile.stamp
105 clean-api-docs-local:
106         -rm -rf reference/ Doxyfile.stamp
108 else
109 all-api-docs-local:;
110 clean-api-docs-local:;
111 endif
113 all-local: all-html-local all-pdf-local all-api-docs-local
114 clean-local: clean-html-local clean-pdf-local clean-api-docs-local
116 uninstall-local:
117         rm -rf $(DOCDIR);
119 # manually install some files under another name
120 install-data-local:
121         $(mkinstalldirs) $(DOCDIR)/html
122         $(INSTALL_DATA) $(srcdir)/geany.html $(DOCDIR)/html/index.html
123         $(INSTALL_DATA) $(srcdir)/geany.txt $(DOCDIR)/manual.txt
124         $(INSTALL_DATA) $(top_srcdir)/scintilla/License.txt $(DOCDIR)/ScintillaLicense.txt