colin/ModemManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: include the logos in the generated documentation

Browse Source
This commit is contained in:
Aleksander Morgado
2012-10-04 11:14:09 +02:00
parent 86ff6b35c3
commit 82f253b8ca
4 changed files with 53 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/reference/api/Makefile.am
View File

@@ -13,6 +13,12 @@ DIAGRAMS_PNG = $(notdir $(DIAGRAMS:.dia=.png))
$(DIAGRAMS_PNG): $(DIAGRAMS) $(DIAGRAMS_PNG): $(DIAGRAMS)
$(AM_V_GEN) $(DIA) -t png $^ 1>/dev/null 2>&1 $(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. # The name of the module.
DOC_MODULE = ModemManager DOC_MODULE = ModemManager
@@ -53,6 +59,7 @@ MKDB_OPTIONS = --output-format=xml --sgml-mode --name-space=mm
# Images to copy into HTML directory # Images to copy into HTML directory
HTML_IMAGES = \ HTML_IMAGES = \
$(DIAGRAMS_PNG) \ $(DIAGRAMS_PNG) \
$(LOGOS_PNG) \
$(NULL) $(NULL)
# Note that PNG files are also added in content_files so that # Note that PNG files are also added in content_files so that
@@ -114,6 +121,9 @@ CLEANFILES += \
-rf xml html tmpl \ -rf xml html tmpl \
$(NULL) $(NULL)
# PNGs generated are removed only in maintainer-clean # PNGs are removed only in dist-clean
MAINTAINERCLEANFILES = \ # Diagrams are generated by dia in the current directory
$(DIAGRAMS_PNG) # Logos are copied to current directory by gtk-doc
DISTCLEANFILES = \
$(DIAGRAMS_PNG) \
$(notdir $(LOGOS_PNG))

11
docs/reference/api/ModemManager-docs.xml
View File

@@ -6,7 +6,16 @@
<book id="ModemManager" xmlns:xi="http://www.w3.org/2003/XInclude"> <book id="ModemManager" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo> <bookinfo>
<title>ModemManager Reference Manual</title> <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> <authorgroup>
<author> <author>

20
docs/reference/libmm-glib/Makefile.am
View File

@@ -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. # The name of the module.
DOC_MODULE = libmm-glib DOC_MODULE = libmm-glib
@@ -41,6 +47,15 @@ GTKDOC_LIBS = \
# Extra options to supply to gtkdoc-mkdb # Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS = --output-format=xml --sgml-mode --name-space=mm 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 if ENABLE_GTK_DOC
include $(top_srcdir)/gtk-doc.make include $(top_srcdir)/gtk-doc.make
else else
@@ -68,3 +83,8 @@ CLEANFILES += \
*.stamp \ *.stamp \
-rf xml html tmpl \ -rf xml html tmpl \
$(NULL) $(NULL)
# PNGs are removed only in maintainer-clean
# Logos are copied to current directory by gtk-doc
DISTCLEANFILES = \
$(notdir $(LOGOS_PNG))

11
docs/reference/libmm-glib/libmm-glib-docs.xml
View File

@@ -6,7 +6,16 @@
<book id="libmm-glib" xmlns:xi="http://www.w3.org/2003/XInclude"> <book id="libmm-glib" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo> <bookinfo>
<title>libmm-glib Reference Manual</title> <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> <authorgroup>
<author> <author>