aboutsummaryrefslogtreecommitdiffstats
path: root/doc/devel/Makefile.am
blob: daf73c2c4fbe74ab8bf27036fef77525ba3b5296 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
## Process this file with automake to produce Makefile.in

SUBDIRS = calendar 

# The name of the module, e.g. 'glib'.
DOC_MODULE=evolution-devel-guide

# The top-level SGML file. Change it if you want.
DOC_MAIN_SGML_FILE=evolution-devel-guide.sgml

# The directory containing the source code. Relative to $(srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting functions and macros.
#DOC_SOURCE_DIR=

# Extra options to supply to gtkdoc-scan.
#SCAN_OPTIONS=

# Extra options to supply to gtkdoc-mkdb.
#MKDB_OPTIONS=

# Extra options to supply to gtkdoc-fixref.
#FIXXREF_OPTIONS=

# Used for dependencies.
#HFILE_GLOB=
#CFILE_GLOB=

# Header files to ignore when scanning.
#IGNORE_HFILES=

# Images to copy into HTML directory.
HTML_IMAGES =


# Add your module's hand-written and auto-generated files here; these
# are used for dependency tracking.

local_entities =                    \
    calendar/alarm-generation.sgml          \
    calendar/architecture.sgml          \
    calendar/evolution-calendar.sgml        \
    calendar/public-reference.sgml          \
                            \
    calendar/cal-client/sgml/cal-client.sgml    \
                            \
    calendar/cal-util/sgml/cal-component.sgml   \
    calendar/cal-util/sgml/cal-recur.sgml       \
    calendar/cal-util/sgml/cal-util.sgml        \
    calendar/cal-util/sgml/timeutil.sgml

#   executive-summary/sgml/executive-summary-component.sgml \
#   executive-summary/sgml/executive-summary-component-factory.sgml \
#   executive-summary/sgml/executive-summary-component-factory-client.sgml  \
#   executive-summary/sgml/executive-summary-html-view.sgml

#   importer/sgml/evolution-importer.sgml       \
#   importer/sgml/evolution-importer-client.sgml

# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
content_files =             \
    fdl.sgml            \
    preface.sgml            \
    reference.sgml          \
    $(local_entities)

# Other files to distribute.
extra_files =

# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
# contains GtkObjects/GObjects and you want to document signals and properties.
#GTKDOC_CFLAGS =
#GTKDOC_LIBS =
#
#GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
#GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)

# If you need to override some of the declarations, place them in this file
# and uncomment this line.
#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt

HTML_DIR = $(datadir)/gnome/html

###########################################################################
# Everything below here is generic and you shouldn't need to change it.
###########################################################################

TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)

EXTRA_DIST =                \
    $(content_files)        \
    $(extra_files)        \
    $(HTML_IMAGES)        \
    $(DOC_MAIN_SGML_FILE)

#   $(DOC_MODULE).types      \
#   $(DOC_MODULE)-sections.txt      \
#   $(DOC_OVERRIDES)

DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
       $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp

#SCANOBJ_FILES =         \
#   $(DOC_MODULE).args      \
#   $(DOC_MODULE).hierarchy \
#   $(DOC_MODULE).signals

if ENABLE_GTK_DOC
all-local: html-build.stamp

#### html ####

html-build.stamp: $(DOC_MAIN_SGML_FILE) $(content_files) #sgml.stamp
    @echo '*** Building HTML ***'
    test -d $(srcdir)/html || mkdir $(srcdir)/html
    cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
    test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
    @echo '-- Fixing Crossreferences' 
    cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
    touch html-build.stamp
endif

##############

clean-local:
    rm -f *~ *.bak *-unused.txt $(DOC_STAMPS) # $(SCANOBJ_FILES)

maintainer-clean-local: clean
    cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt

install-data-local:
    $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
    (installfiles=`echo $(srcdir)/html/*.html`; \
    if test "$$installfiles" = '$(srcdir)/html/*.html'; \
    then echo '-- Nothing to install' ; \
    else \
      for i in $$installfiles; do \
        echo '-- Installing '$$i ; \
        $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
      done; \
    fi)

#     echo '-- Installing $(srcdir)/html/index.sgml' ; \
#     $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \

#
# Require gtk-doc when making dist
#
if ENABLE_GTK_DOC
dist-check-gtkdoc:
else
dist-check-gtkdoc:
    @echo "*** gtk-doc must be installed and enabled in order to make dist"
    @false
endif

dist-hook: dist-check-gtkdoc dist-hook-local
    mkdir $(distdir)/html
    -cp $(srcdir)/html/index.sgml $(distdir)/html
    -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
    images=$(HTML_IMAGES) ;        \
    for i in $$images ; do      \
      cp $(srcdir)/$$i $(distdir)/html ;  \
    done

#   mkdir $(distdir)/tmpl
#   mkdir $(distdir)/sgml
#   -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
#   -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl

.PHONY : dist-hook-local