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