summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAleksander Morgado <aleksander@lanedo.com>2012-10-04 11:14:09 +0200
committerAleksander Morgado <aleksander@lanedo.com>2012-10-04 12:10:22 +0200
commit82f253b8ca69cdc99f8e72ba9548c7493baed604 (patch)
treeb9e8b71f535fb1de0dee4c5aeff3aafb29416fd1 /docs
parent86ff6b35c34604184fc5f44527abad8969d5cebd (diff)
docs: include the logos in the generated documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/api/Makefile.am16
-rw-r--r--docs/reference/api/ModemManager-docs.xml11
-rw-r--r--docs/reference/libmm-glib/Makefile.am20
-rw-r--r--docs/reference/libmm-glib/libmm-glib-docs.xml11
4 files changed, 53 insertions, 5 deletions
diff --git a/docs/reference/api/Makefile.am b/docs/reference/api/Makefile.am
index 09d5281a..9358484d 100644
--- a/docs/reference/api/Makefile.am
+++ b/docs/reference/api/Makefile.am
@@ -13,6 +13,12 @@ DIAGRAMS_PNG = $(notdir $(DIAGRAMS:.dia=.png))
$(DIAGRAMS_PNG): $(DIAGRAMS)
$(AM_V_GEN) $(DIA) -t png $^ 1>/dev/null 2>&1
+# Logos
+LOGOS_PNG = \
+ $(top_srcdir)/data/ModemManager-logo-square.png \
+ $(top_srcdir)/data/ModemManager-logo-wide.png \
+ $(top_srcdir)/data/ModemManager-logo-wide-text.png
+
# The name of the module.
DOC_MODULE = ModemManager
@@ -53,6 +59,7 @@ MKDB_OPTIONS = --output-format=xml --sgml-mode --name-space=mm
# Images to copy into HTML directory
HTML_IMAGES = \
$(DIAGRAMS_PNG) \
+ $(LOGOS_PNG) \
$(NULL)
# Note that PNG files are also added in content_files so that
@@ -114,6 +121,9 @@ CLEANFILES += \
-rf xml html tmpl \
$(NULL)
-# PNGs generated are removed only in maintainer-clean
-MAINTAINERCLEANFILES = \
- $(DIAGRAMS_PNG)
+# PNGs are removed only in dist-clean
+# Diagrams are generated by dia in the current directory
+# Logos are copied to current directory by gtk-doc
+DISTCLEANFILES = \
+ $(DIAGRAMS_PNG) \
+ $(notdir $(LOGOS_PNG))
diff --git a/docs/reference/api/ModemManager-docs.xml b/docs/reference/api/ModemManager-docs.xml
index 17bc814a..97654fb9 100644
--- a/docs/reference/api/ModemManager-docs.xml
+++ b/docs/reference/api/ModemManager-docs.xml
@@ -6,7 +6,16 @@
<book id="ModemManager" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>ModemManager Reference Manual</title>
- <releaseinfo>For ModemManager version &version;</releaseinfo>
+ <subtitle>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="ModemManager-logo-wide.png" format="PNG" align="center"/>
+ </imageobject>
+ </inlinemediaobject>
+ </subtitle>
+ <releaseinfo>
+ For ModemManager version &version;
+ </releaseinfo>
<authorgroup>
<author>
diff --git a/docs/reference/libmm-glib/Makefile.am b/docs/reference/libmm-glib/Makefile.am
index ce841387..53afed97 100644
--- a/docs/reference/libmm-glib/Makefile.am
+++ b/docs/reference/libmm-glib/Makefile.am
@@ -1,4 +1,10 @@
+# Logos
+LOGOS_PNG = \
+ $(top_srcdir)/data/ModemManager-logo-square.png \
+ $(top_srcdir)/data/ModemManager-logo-wide.png \
+ $(top_srcdir)/data/ModemManager-logo-wide-text.png
+
# The name of the module.
DOC_MODULE = libmm-glib
@@ -41,6 +47,15 @@ GTKDOC_LIBS = \
# Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS = --output-format=xml --sgml-mode --name-space=mm
+# Images to copy into HTML directory
+HTML_IMAGES = \
+ $(LOGOS_PNG) \
+ $(NULL)
+
+content_files = \
+ $(HTML_IMAGES) \
+ $(NULL)
+
if ENABLE_GTK_DOC
include $(top_srcdir)/gtk-doc.make
else
@@ -68,3 +83,8 @@ CLEANFILES += \
*.stamp \
-rf xml html tmpl \
$(NULL)
+
+# PNGs are removed only in maintainer-clean
+# Logos are copied to current directory by gtk-doc
+DISTCLEANFILES = \
+ $(notdir $(LOGOS_PNG))
diff --git a/docs/reference/libmm-glib/libmm-glib-docs.xml b/docs/reference/libmm-glib/libmm-glib-docs.xml
index 431fcd04..6e3c7178 100644
--- a/docs/reference/libmm-glib/libmm-glib-docs.xml
+++ b/docs/reference/libmm-glib/libmm-glib-docs.xml
@@ -6,7 +6,16 @@
<book id="libmm-glib" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>libmm-glib Reference Manual</title>
- <releaseinfo>For libmm-glib version &version;</releaseinfo>
+ <subtitle>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="ModemManager-logo-wide.png" format="PNG" align="center"/>
+ </imageobject>
+ </inlinemediaobject>
+ </subtitle>
+ <releaseinfo>
+ For libmm-glib version &version;
+ </releaseinfo>
<authorgroup>
<author>