doc/Makefile.am

   1 apidir = @htmldir@/api
   2
   3 MAN_XML_FILES = \
   4         dbus-cleanup-sockets.1.xml \
   5         dbus-daemon.1.xml \
   6         dbus-launch.1.xml \
   7         dbus-monitor.1.xml \
   8         dbus-send.1.xml \
   9         dbus-uuidgen.1.xml \
  10         $(NULL)
  11
  12 if DBUS_XML_DOCS_ENABLED
  13 man1_MANS = \
  14         dbus-cleanup-sockets.1 \
  15         dbus-daemon.1 \
  16         dbus-launch.1 \
  17         dbus-monitor.1 \
  18         dbus-send.1 \
  19         dbus-uuidgen.1
  20 endif
  21
  22 MAN_HTML_FILES = \
  23         dbus-cleanup-sockets.1.html \
  24         dbus-daemon.1.html \
  25         dbus-launch.1.html \
  26         dbus-monitor.1.html \
  27         dbus-send.1.html \
  28         dbus-uuidgen.1.html
  29
  30 DTDS = \
  31         busconfig.dtd \
  32         introspect.dtd
  33
  34 dist_doc_DATA = system-activation.txt
  35
  36 # uploaded and distributed, but not installed
  37 STATIC_DOCS = \
  38         dbus-faq.xml \
  39         dbus-specification.xml \
  40         dbus-test-plan.xml \
  41         dbus-tutorial.xml \
  42         dcop-howto.txt \
  43         introspect.xsl \
  44         $(DTDS)
  45
  46 EXTRA_DIST = \
  47         file-boilerplate.c \
  48         doxygen_to_devhelp.xsl \
  49         $(STATIC_DOCS)
  50
  51 html_DATA =
  52
  53 dist_html_DATA =
  54
  55 # diagram.png/diagram.svg aren't really HTML, but must go in the same
  56 # directory as the HTML to avoid broken links
  57 STATIC_HTML = \
  58         diagram.png \
  59         diagram.svg \
  60         $(NULL)
  61
  62 dist_html_DATA += $(STATIC_HTML)
  63
  64 XMLTO_HTML =                                    \
  65         dbus-faq.html                           \
  66         dbus-specification.html                 \
  67         dbus-test-plan.html                     \
  68         dbus-tutorial.html                      \
  69         $(MAN_HTML_FILES)                       \
  70         $(NULL)
  71
  72 if DBUS_XML_DOCS_ENABLED
  73 html_DATA += $(XMLTO_HTML)
  74
  75 %.html: %.xml
  76         $(XMLTO) html-nochunks $<
  77
  78 %.1: %.1.xml
  79         $(XMLTO) man $<
  80 endif
  81
  82 if DBUS_DOXYGEN_DOCS_ENABLED
  83 all-local:: doxygen.stamp
  84
  85 doxygen.stamp: $(wildcard $(top_srcdir)/dbus/*.[ch])
  86         $(AM_V_GEN)cd $(top_builddir) && doxygen Doxyfile
  87         @touch $@
  88
  89 if DBUS_HAVE_XSLTPROC
  90 html_DATA += dbus.devhelp
  91
  92 dbus.devhelp: $(srcdir)/doxygen_to_devhelp.xsl doxygen.stamp
  93         $(XSLTPROC) -o $@ $< api/xml/index.xml
  94 endif
  95
  96 # this assumes CREATE_SUBDIRS isn't set to YES in Doxyfile
  97 # (which it isn't currently)
  98 install-data-local:: doxygen.stamp
  99         $(MKDIR_P) $(DESTDIR)$(apidir)
 100         $(INSTALL_DATA) api/html/* $(DESTDIR)$(apidir)
 101
 102 uninstall-local::
 103         rm -f $(DESTDIR)$(apidir)/*.html
 104         rm -f $(DESTDIR)$(apidir)/*.png
 105         rm -f $(DESTDIR)$(apidir)/*.css
 106         rm -f $(DESTDIR)$(apidir)/*.js
 107         rm -f $(DESTDIR)$(htmldir)/*.html
 108         rm -f $(DESTDIR)$(docdir)/*.txt
 109         rm -f $(DESTDIR)$(htmldir)/*.png
 110         rm -f $(DESTDIR)$(htmldir)/*.svg
 111         rmdir --ignore-fail-on-non-empty $(DESTDIR)$(apidir) || \
 112                 rmdir $(DESTDIR)$(apidir)
 113 endif
 114
 115 if DBUS_CAN_UPLOAD_DOCS
 116 BONUS_FILES = \
 117         $(top_srcdir)/README \
 118         $(top_srcdir)/HACKING \
 119         $(top_srcdir)/AUTHORS \
 120         $(top_srcdir)/NEWS \
 121         $(top_srcdir)/COPYING \
 122         $(top_srcdir)/ChangeLog
 123
 124 dbus-docs: $(STATIC_DOCS) $(MAN_XML_FILES) $(dist_doc_DATA) $(dist_html_DATA) $(MAN_HTML_FILES) $(BONUS_FILES) doxygen.stamp $(XMLTO_HTML)
 125         $(AM_V_at)rm -rf $@ $@.tmp
 126         $(AM_V_GEN)$(MKDIR_P) $@.tmp/api
 127         $(AM_V_at)cd $(srcdir) && cp $(STATIC_DOCS) @abs_builddir@/$@.tmp
 128         $(AM_V_at)cd $(srcdir) && cp $(dist_doc_DATA) @abs_builddir@/$@.tmp
 129         $(AM_V_at)cd $(srcdir) && cp $(STATIC_HTML) @abs_builddir@/$@.tmp
 130         $(AM_V_at)cp $(XMLTO_HTML) @abs_builddir@/$@.tmp
 131         $(AM_V_at)cp $(MAN_HTML_FILES) @abs_builddir@/$@.tmp
 132         $(AM_V_at)cp $(MAN_XML_FILES) @abs_builddir@/$@.tmp
 133         $(AM_V_at)cp $(BONUS_FILES) @abs_builddir@/$@.tmp
 134         $(AM_V_at)cp -r api/html @abs_builddir@/$@.tmp/api
 135         $(AM_V_at)mv $@.tmp $@
 136
 137 dbus-docs.tar.gz: dbus-docs
 138         $(AM_V_GEN)tar czf $@ $<
 139
 140 DOC_SERVER = dbus.freedesktop.org
 141 DOC_WWW_DIR = /srv/dbus.freedesktop.org/www
 142
 143 SPECIFICATION_SERVER = specifications.freedesktop.org
 144 SPECIFICATION_PATH = /srv/specifications.freedesktop.org/www/dbus/1.0
 145
 146 maintainer-upload-docs: dbus-docs.tar.gz dbus-docs
 147         scp dbus-docs.tar.gz $(DOC_SERVER):$(DOC_WWW_DIR)/
 148         rsync -rpvzP --chmod=Dg+s,ug+rwX,o=rX \
 149                 dbus-docs/ $(DOC_SERVER):$(DOC_WWW_DIR)/doc/
 150         cd $(srcdir) && scp -p $(DTDS) $(SPECIFICATION_SERVER):$(SPECIFICATION_PATH)/
 151 else
 152 maintainer-upload-docs:
 153         @echo "Can't upload documentation! Re-run configure with"
 154         @echo "  --enable-doxygen-docs --enable-xml-docs"
 155         @echo "and ensure that man2html is installed."
 156         @false
 157 endif
 158
 159 CLEANFILES = \
 160         $(man1_MANS) \
 161         $(MAN_XML_FILES) \
 162         $(XMLTO_HTML) \
 163         $(NULL)
 164
 165 clean-local:
 166         rm -f $(html_DATA)
 167         rm -rf api
 168         rm -rf dbus-docs dbus-docs.tmp
 169         rm -f *.1.html
 170         rm -f doxygen.stamp