brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Clean up the additional documentation build

Browse Source 
• Make the manual a DevHelp book

• Make the generation of PDFs of the cookbook and the manual optional

• Consequently, make the hard dependency on jw optional

• Clean up the checks and build for the additional documentation
This commit is contained in:
Emmanuele Bassi 2009-09-03 13:04:59 +01:00
parent ee9d358c45
commit 5e1ccaeb60
14 changed files with 111 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
.gitignore vendored
View File

@ -31,13 +31,14 @@ clutter/stamp-*
config.*
configure
depcomp
/doc/cookbook/version.xml
/doc/cookbook/version.xml
/doc/cookbook/*.pdf
/doc/cookbook/*.txt
/doc/cookbook/html
/doc/cookbook/*.stamp
doc/manual/clutter-manual.xml
/doc/cookbook/clutter-cookbook.xml
/doc/manual/*.pdf
/doc/manual/html
/doc/manual/*.stamp
/doc/manual/clutter-manual.xml
doc/reference/clutter/clutter-*.txt
!/doc/reference/clutter/clutter-sections.txt
doc/reference/clutter/html

39
configure.ac
View File

@ -751,32 +751,32 @@ AC_SUBST(PANGO_PREFIX)
dnl === Manual ================================================================
AC_ARG_ENABLE([manual],
[AC_HELP_STRING([--enable-manual=@<:@no/yes@:>@],
[Build application developers manual. Requires jw and xmlto.])],
[enable_manual=$enableval],
[enable_manual=no])
AC_ARG_ENABLE([docs],
[AC_HELP_STRING([--enable-docs=@<:@no/yes@:>@],
[Build optional documentation; requires xsltproc and jw.])],
[enable_docs=$enableval],
[enable_docs=no])
AS_IF([test "x$enable_manual" = "xyes"],
enable_pdfs=no
AS_IF([test "x$enable_docs" = "xyes"],
[
AC_PATH_PROG(JW, [jw], [no])
AS_IF([test "x$JW" = "xno"],
[AC_MSG_ERROR(['jw' program needed by the manual not found in PATH])]
)
AC_PATH_PROG(XMLTO, [xmlto], [no])
AS_IF([test "x$XMLTO" = "xno"],
[AC_MSG_ERROR(['xmlto' program needed by the manual not found in PATH])]
)
[
AC_MSG_WARN([jw not found; pdf generation has been disabled])
],
[enable_pdfs=yes])
AC_PATH_PROG(XSLTPROC, [xsltproc], [no])
AS_IF([test "x$XSLTPROC" = "xno"],
[AC_MSG_ERROR(['xsltproc' needed by the manual not found in PATH])]
)
[
AC_MSG_ERROR([xsltproc not found])
])
]
)
AM_CONDITIONAL(ENABLE_MANUAL, [test "x$enable_manual" = "xyes"])
AM_CONDITIONAL(ENABLE_DOCS, [test "x$enable_docs" = "xyes"])
AM_CONDITIONAL(ENABLE_PDFS, [test "x$enable_pdfs" = "xyes"])
dnl === I18N ==================================================================
@ -847,10 +847,11 @@ AC_CONFIG_FILES([
doc/reference/clutter/clutter-docs.xml
doc/reference/cogl/Makefile
doc/reference/cogl/cogl-docs.xml
doc/manual/clutter-manual.xml
doc/common/Makefile
doc/manual/Makefile
doc/cookbook/version.xml
doc/manual/clutter-manual.xml
doc/cookbook/Makefile
doc/cookbook/clutter-cookbook.xml
po/Makefile.in
clutter.pc
])
@ -877,7 +878,7 @@ echo " Compiler flags: ${MAINTAINER_CFLAGS}"
echo ""
echo " • Documentation:"
echo " Build API Reference: ${enable_gtk_doc}"
echo " Build Manual: ${enable_manual}"
echo " Build Additional Documentation: ${enable_docs}"
echo ""
echo " • Extra:"

8
doc/Makefile.am
View File

@ -1 +1,7 @@
SUBDIRS=reference manual
SUBDIRS = reference
if ENABLE_DOCS
SUBDIRS += common cookbook manual
endif
DIST_SUBDIRS = reference common cookbook manual

9
doc/common/Makefile.am Normal file
View File

@ -0,0 +1,9 @@
NULL =
EXTRA_DIST = \
common.xsl \
devhelp.xsl \
html.xsl \
ref-html-style.xsl \
style.css \
$(NULL)

0
doc/cookbook/common.xsl → doc/common/common.xsl
View File

0
doc/cookbook/devhelp.xsl → doc/common/devhelp.xsl
View File

0
doc/cookbook/html.xsl → doc/common/html.xsl
View File

0
doc/cookbook/ref-html-style.xsl → doc/common/ref-html-style.xsl
View File

0
doc/cookbook/style.css → doc/common/style.css
View File

30
doc/cookbook/Makefile.am
View File

@ -4,20 +4,11 @@ TARGET_DIR = $(HTML_DIR)/clutter-cookbook
HTML_FILES = $(srcdir)/html/*.html
IMAGE_FILES = $(srcdir)/images/*.png
EXTRA_DIST = \
version.xml.in \
cookbook.xsl \
common.xsl \
devhelp.xsl \
html.xsl \
ref-html-style.xsl \
style.css \
$(IMAGE_FILES)
EXTRA_DIST = $(IMAGE_FILES) clutter-cookbook.xml.in
CLEANFILES = \
pdf-build.stamp \
txt-build.stamp \
htmldoc-build.stamp
html-build.stamp
pdf-build.stamp: clutter-cookbook.xml
SP_ENCODING=XML SP_CHARSET_FIXED=YES \
@ -28,6 +19,7 @@ pdf-build.stamp: clutter-cookbook.xml
html-build.stamp: clutter-cookbook.xml
$(mkinstalldirs) html \
&& $(XSLTPROC) --nonet --xinclude -o $(srcdir)/html/ \
--path $(top_srcdir)/doc/common \
--path $(srcdir) \
--stringparam gtkdoc.bookname "clutter-cookbook" \
--stringparam gtkdoc.version @CLUTTER_API_VERSION@ \
@ -35,15 +27,21 @@ html-build.stamp: clutter-cookbook.xml
$(srcdir)/clutter-cookbook.xml \
&& echo timestamp > $(@F)
if ENABLE_MANUAL
all-local: html-build.stamp
if ENABLE_PDFS
pdf_target = pdf-build.stamp
else
pdf_target =
endif
if ENABLE_DOCS
all-local: html-build.stamp $(pdf_target)
else
all-local:
endif
clean-local:
rm -rf html
rm -f *.pdf
@rm -rf html ; \
rm -f *.pdf ; \
rm -f *.stamp
uninstall-local:
@ -72,7 +70,7 @@ install-data-local:
fi \
done; \
fi; \
$(INSTALL_DATA) $(srcdir)/style.css $(DESTDIR)$(TARGET_DIR)/style.css; \
$(INSTALL_DATA) $(top_srcdir)/doc/common/style.css $(DESTDIR)$(TARGET_DIR)/style.css; \
$(INSTALL_DATA) $(srcdir)/html/clutter-cookbook.devhelp $(DESTDIR)$(TARGET_DIR)/clutter-cookbook.devhelp
.PHONY : doc

7
doc/cookbook/clutter-cookbook.xml → doc/cookbook/clutter-cookbook.xml.in
View File

@ -4,7 +4,7 @@
<!ENTITY appurl "http://clutter-project.org">
<!ENTITY docurl "http://clutter-project.org/docs/">
<!ENTITY author_mail "ebassi@linux.intel.com">
<!ENTITY version SYSTEM "version.xml">
<!ENTITY apiversion "@CLUTTER_API_VERSION@">
]>
<book lang="en">
@ -17,7 +17,7 @@
</author>
<copyright>
<year>2008</year>
<year>2009</year>
<holder>Intel Corporation</holder>
</copyright>
@ -29,7 +29,8 @@
source code of this program.</para>
</legalnotice>
<title>The Clutter Cookbook &version;</title>
<title>The Clutter Cookbook</title>
<releaseinfo>for Clutter &apiversion;</releaseinfo>
</bookinfo> <!-- }}} -->
<chapter id="introduction"> <!-- {{{ -->

14
doc/cookbook/cookbook.xsl
View File

@ -1,14 +0,0 @@
<?xml version='1.0'?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
version='1.0'
xmlns="http://www.w3.org/TR/xhtml1/transitional"
exclude-result-prefixes="#default">
<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"/>
<!-- Use stylesheet -->
<xsl:param name="html.stylesheet" select="'style.css'"/>
<xsl:param name="chunker.output.encoding" select="'UTF-8'"/>
</xsl:stylesheet>

84
doc/manual/Makefile.am
View File

@ -1,64 +1,76 @@
DOCDIR = $(DESTDIR)/$(datadir)/doc/@PACKAGE@-@CLUTTER_API_VERSION@
HTML_FILES = html/*.html
IMAGE_FILES = images/*.png
EXTRA_DIST = clutter-manual.xml.in manual.xsl style.css $(srcdir)/$(IMAGE_FILES)
CLEANFILES = pdf-build.stamp txt-build.stamp htmldoc-build.stamp clutter-manual.xml
HTML_DIR = $(datadir)/gtk-doc/html
TARGET_DIR = $(HTML_DIR)/clutter-manual
HTML_FILES = $(srcdir)/html/*.html
IMAGE_FILES = $(srcdir)/images/*.png
EXTRA_DIST = $(IMAGE_FILES)
CLEANFILES = \
pdf-build.stamp \
html-build.stamp
pdf-build.stamp: clutter-manual.xml
SP_ENCODING=XML SP_CHARSET_FIXED=YES \
$(JW) -b pdf $(srcdir)/clutter-manual.xml && \
mv $(srcdir)/clutter-manual.pdf clutter-manual-@CLUTTER_API_VERSION@.pdf && \
touch pdf-build.stamp
$(JW) -b pdf $(srcdir)/clutter-manual.xml \
&& mv -f $(srcdir)/clutter-manual.pdf clutter-manual-@CLUTTER_API_VERSION@.pdf \
&& echo timestamp > $(@F)
txt-build.stamp: clutter-manual.xml
$(XMLTO) txt $(srcdir)/clutter-manual.xml && \
mv $(srcdir)/clutter-manual.txt clutter-manual-@CLUTTER_API_VERSION@.txt && \
touch txt-build.stamp
html-build.stamp: clutter-manual.xml
$(mkinstalldirs) html \
&& $(XSLTPROC) --nonet --xinclude -o $(srcdir)/html/ \
--path $(top_srcdir)/doc/common \
--path $(srcdir) \
--stringparam gtkdoc.bookname "clutter-manual" \
--stringparam gtkdoc.version @CLUTTER_API_VERSION@ \
$(srcdir)/ref-html-style.xsl \
$(srcdir)/clutter-manual.xml \
&& echo timestamp > $(@F)
htmldoc-build.stamp: clutter-manual.xml
$(mkinstalldirs) html && \
$(XMLTO) -m manual.xsl -o html/ xhtml $(srcdir)/clutter-manual.xml && \
cp $(srcdir)/style.css html/ && \
touch htmldoc-build.stamp
if ENABLE_PDFS
pdf_target = pdf-build.stamp
else
pdf_target =
endif
doc: txt-build.stamp htmldoc-build.stamp pdf-build.stamp
if ENABLE_MANUAL
all-local: doc
if ENABLE_DOCS
all-local: html-build.stamp $(pdf_target)
else
all-local:
endif
clean-local:
rm -rf html/*.html
rm -f html/style.css
rm -f clutter-manual-*.txt
rm -f *.pdf
@rm -rf html ; \
rm -f *.pdf ; \
rm -f *.stamp
uninstall-local:
rm -rf $(DOCDIR);
install-data-local:
installfiles=`echo $(srcdir)/html/*`; \
if test "$$installfiles" = '$(srcdir)/html/*'; then \
echo '-- Nothing to install' ; \
if test "$$installfiles" = '$(srcdir)/html/*'; \
then echo '-- Nothing to install' ; \
else \
$(mkinstalldirs) $(DOCDIR)/html/images ; \
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) ; \
for file in `ls $(srcdir)/$(HTML_FILES)`; do \
if [ -f $$file ]; then \
basefile=`echo $$file | sed -e 's,^.*/,,'`; \
$(INSTALL_DATA) $$file $(DOCDIR)/html/$$basefile; \
$(INSTALL_DATA) $$file $(DESTDIR)$(TARGET_DIR)/$$basefile; \
fi \
done; \
fi; \
if [ -d $(srcdir)/images ]; \
then \
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)/images ; \
for file in `ls $(srcdir)/$(IMAGE_FILES)`; do \
if [ -f $$file ]; then \
if [ -f $$file ]; \
then \
basefile=`echo $$file | sed -e 's,^.*/,,'`; \
$(INSTALL_DATA) $$file $(DOCDIR)/html/images/$$basefile; \
$(INSTALL_DATA) $$file $(DESTDIR)$(TARGET_DIR)/images/$$basefile; \
fi \
done; \
$(INSTALL_DATA) $(srcdir)/style.css $(DOCDIR)/html/style.css; \
$(INSTALL_DATA) $(srcdir)/clutter-manual-@CLUTTER_API_VERSION@.txt $(DOCDIR)/clutter-manual-@CLUTTER_API_VERSION@.txt; \
$(INSTALL_DATA) $(srcdir)/clutter-manual-@CLUTTER_API_VERSION@.pdf $(DOCDIR)/clutter-manual-@CLUTTER_API_VERSION@.pdf; \
fi
fi; \
$(INSTALL_DATA) $(top_srcdir)/doc/common/style.css $(DESTDIR)$(TARGET_DIR)/style.css; \
$(INSTALL_DATA) $(srcdir)/html/clutter-manual.devhelp $(DESTDIR)$(TARGET_DIR)/clutter-manual.devhelp
.PHONY : doc

9
doc/manual/clutter-manual.xml.in
View File

@ -1,8 +1,8 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY appversion "@CLUTTER_MAJORMINOR@">
<!ENTITY appurl "http://clutter-project.org">
<!ENTITY apiversion "@CLUTTER_API_VERSION@">
<!ENTITY appurl "http://www.clutter-project.org/docs">
<!ENTITY author_mail "mallum@o-hand.com">
]>
@ -24,9 +24,8 @@
program.
</para>
</legalnotice>
<title>
Clutter Application Developer Manual &appversion;
</title>
<title>Clutter Application Developer Manual</title>
<releaseinfo>for Clutter &apiversion;</releaseinfo>
</bookinfo>
<chapter id="intro">