[hipl-commit] [trunk] Rev 4140: Build HTML documentation in a single file instead of multiple files.

  • From: Diego Biurrun <diego@xxxxxxxxxx>
  • To: hipl-commit@xxxxxxxxxxxxx
  • Date: Tue, 6 Apr 2010 16:42:05 +0300

Committer: Diego Biurrun <diego@xxxxxxxxxx>
Date: 06/04/2010 at 16:42:05
Revision: 4140
Revision-id: diego@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Branch nick: trunk

Log:
  Build HTML documentation in a single file instead of multiple files.
  
  Somehow convincing autotools to properly build, install and uninstall
  documentation in a separate subdirectory is far from trivial.
  Generating a single HTML file is a reasonable compromise: it simplifies
  the build system and avoids some bugs, yet the generated HTML document
  is not so large as to become unwieldy.

Modified:
  M  .bzrignore
  M  Makefile.am
  M  doc/HOWTO.xml

=== modified file '.bzrignore'
--- .bzrignore  2010-04-01 15:45:19 +0000
+++ .bzrignore  2010-04-06 13:39:28 +0000
@@ -33,9 +33,9 @@
 debian/hipl.debhelper.log
 debian/hipl.substvars
 depcomp
+doc/HOWTO.html
 doc/HOWTO.txt
 doxy/
-doc/howto-html/
 firewall/hipfw
 hipd/hipd
 hipl-main.tar.gz

=== modified file 'Makefile.am'
--- Makefile.am 2010-04-06 13:37:14 +0000
+++ Makefile.am 2010-04-06 13:39:28 +0000
@@ -628,21 +628,17 @@
 doxygen:
        doxygen Doxyfile
 
-dist_doc_DATA = doc/HOWTO.txt $(wildcard $(addprefix $(srcdir)/doc/,*.png))
+dist_doc_DATA = doc/HOWTO.html doc/HOWTO.txt $(wildcard $(addprefix 
$(srcdir)/doc/,*.png))
+
+doc/HOWTO.html:  doc/HOWTO.xml
+       xmlto -o $(@D) html-nochunks $<
 
 doc/HOWTO.txt: doc/HOWTO.xml
        xmlto -o $(@D) txt $<
 
-doc/howto-html/index.html:  doc/HOWTO.xml
-       xmlto -o $(@D) html $<
-
-install-data-hook: doc/howto-html/index.html
-       cp -r $(<D) $(DESTDIR)$(docdir)
-
-CLEANFILES += doc/HOWTO.txt
+CLEANFILES += doc/HOWTO.html doc/HOWTO.txt
 clean-local:
        rm -rf doxy
-       rm -rf doc/howto-html
 
 # The olddeb target is for maemo builds only
 bin deb increl olddeb rpm syncrepo:

=== modified file 'doc/HOWTO.xml'
--- doc/HOWTO.xml       2010-04-01 17:44:59 +0000
+++ doc/HOWTO.xml       2010-04-06 13:39:28 +0000
@@ -3194,7 +3194,7 @@
         </para>
         <mediaobject>
           <imageobject>
-            <imagedata fileref="../base-exchange-rvs.png" scale="100" 
align="center" format="PNG"/>
+            <imagedata fileref="base-exchange-rvs.png" scale="100" 
align="center" format="PNG"/>
           </imageobject>
           <caption>
             <para>
@@ -3472,7 +3472,7 @@
         </para>
         <mediaobject>
           <imageobject>
-            <imagedata fileref="../base-exchange-relay.png" scale="100" 
align="center" format="PNG"/>
+            <imagedata fileref="base-exchange-relay.png" scale="100" 
align="center" format="PNG"/>
           </imageobject>
           <caption>
             <para>Base exchange via the relay server</para>
@@ -4076,7 +4076,7 @@
                 <screeninfo>HIP configuration GUI main window</screeninfo>
                 <mediaobject>
                 <imageobject>
-                <imagedata fileref="../docshot-agent-main-window.png" 
scale="100" align="center" format="PNG"/>
+                <imagedata fileref="docshot-agent-main-window.png" scale="100" 
align="center" format="PNG"/>
                 </imageobject>
                 <caption>
                 <para>HIP configuration GUI main window</para>
@@ -4118,7 +4118,7 @@
                 <screeninfo>HIP configuration GUI tray icon</screeninfo>
                 <mediaobject>
                 <imageobject>
-                <imagedata fileref="../docshot-agent-tray-icon.png" 
scale="100" align="center" format="PNG"/>
+                <imagedata fileref="docshot-agent-tray-icon.png" scale="100" 
align="center" format="PNG"/>
                 </imageobject>
                 <caption>
                 <para>HIP configuration GUI tray icon</para>

Other related posts:

  • » [hipl-commit] [trunk] Rev 4140: Build HTML documentation in a single file instead of multiple files. - Diego Biurrun