[DRE-commits] [ruby-builder] 05/06: [evol] added doc package

[Marc Dequènes]

This is an automated email from the git hooks/post-receive script.

duck pushed a commit to branch master
in repository ruby-builder.

commit b61d89eba1bd9f5f84b92d5fbda6ffda67889df7
Author: Marc Dequènes (Duck) <Duck at DuckCorp.org>
Date:   Fri Jan 3 19:55:08 2014 +0100

    [evol] added doc package
---
 debian/changelog                 |  1 +
 debian/control                   | 23 ++++++++++++++++++++++-
 debian/ruby-builder-doc.doc-base | 10 ++++++++++
 debian/ruby-builder-doc.docs     |  1 +
 debian/rules                     | 16 ++++++++++++++++
 5 files changed, 50 insertions(+), 1 deletion(-)

diff --git a/debian/changelog b/debian/changelog
index 10b609c..357ce31 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -2,6 +2,7 @@ ruby-builder (3.2.2-1) UNRELEASED; urgency=medium
 
   * New upstream release.
   * Bumped Standards-Version to 3.9.5 (no changes).
+  * Added documentation package.
 
  -- Marc Dequènes (Duck) <Duck at DuckCorp.org>  Fri, 03 Jan 2014 19:22:17 +0100
 
diff --git a/debian/control b/debian/control
index 3303591..6c17066 100644
--- a/debian/control
+++ b/debian/control
@@ -3,7 +3,7 @@ Section: ruby
 Priority: optional
 Maintainer: Marc Dequènes (Duck) <Duck at DuckCorp.org>
 Uploaders: Debian Ruby Extras Maintainers <pkg-ruby-extras-maintainers at lists.alioth.debian.org>, Paul van Tilburg <paulvt at debian.org>, Antonio Terceiro <terceiro at debian.org>
-Build-Depends: debhelper (>= 7.0.50~), gem2deb (>= 0.3.0~), ruby-blankslate
+Build-Depends: debhelper (>= 7.0.50~), gem2deb (>= 0.3.0~), ruby-blankslate, ruby2.0
 Standards-Version: 3.9.5
 Vcs-Git: git://anonscm.debian.org/pkg-ruby-extras/ruby-builder.git
 Vcs-Browser: http://anonscm.debian.org/gitweb?p=pkg-ruby-extras/ruby-builder.git;a=summary
@@ -14,6 +14,7 @@ Package: ruby-builder
 Architecture: all
 XB-Ruby-Versions: ${ruby:Versions}
 Depends: ${shlibs:Depends}, ${misc:Depends}, ruby | ruby-interpreter, ruby-blankslate
+Suggests: ruby-builder-doc
 Description: Ruby library to facilitate programatic generation of XML markup
  Builder is a library that allows easy programmatic creation of XML markup. It
  gives you a Ruby API to build structures and methods to dump it to XML.
@@ -25,3 +26,23 @@ Description: Ruby library to facilitate programatic generation of XML markup
   * Some support for XML namespaces.
   * Default escaping of string attribute values.
   * UTF-8 support.
+
+Package: ruby-builder-doc
+Architecture: all
+Section: doc
+Depends: ${misc:Depends}, libjs-jquery
+Suggests: doc-base
+Description: Ruby library to facilitate programatic generation of XML markup
+ Builder is a library that allows easy programmatic creation of XML markup. It
+ gives you a Ruby API to build structures and methods to dump it to XML.
+ Some of the features:
+  * Easy generation by mapping method calls to elements, arguments to
+    attributes and blocks to contents.
+  * XML comment & processing instruction support.
+  * XML entity declaration support.
+  * Some support for XML namespaces.
+  * Default escaping of string attribute values.
+  * UTF-8 support.
+ .
+ This is the Rdoc-generated documentation for Builder.
+
diff --git a/debian/ruby-builder-doc.doc-base b/debian/ruby-builder-doc.doc-base
new file mode 100644
index 0000000..4ac56c9
--- /dev/null
+++ b/debian/ruby-builder-doc.doc-base
@@ -0,0 +1,10 @@
+Document: ruby-builder
+Title: Builder Documentation
+Author: Jim Weirich
+Abstract: Rdoc-generated API documentation.
+Section: Programming/Ruby
+
+Format: HTML
+Index: /usr/share/doc/ruby-builder-doc/rdoc/index.html
+Files: /usr/share/doc/ruby-builder-doc/rdoc/*
+
diff --git a/debian/ruby-builder-doc.docs b/debian/ruby-builder-doc.docs
new file mode 100644
index 0000000..3a67a3b
--- /dev/null
+++ b/debian/ruby-builder-doc.docs
@@ -0,0 +1 @@
+build-doc/rdoc
diff --git a/debian/rules b/debian/rules
index 20189d7..8543aa2 100755
--- a/debian/rules
+++ b/debian/rules
@@ -14,6 +14,22 @@
 %:
 	dh $@ --buildsystem=ruby --with ruby
 
+override_dh_auto_build:
+	dh_auto_build
+	# rdoc 2.0 is needed to handle markdown correctly
+	rdoc2.0 -a -t 'Builder API' -f darkfish -m README.md -o build-doc/rdoc lib README.md
+
 override_dh_install:
 	dh_install
 	rm debian/ruby-builder/usr/lib/ruby/vendor_ruby/blankslate.rb
+
+override_dh_installdocs:
+	dh_installdocs --remaining-packages
+	# avoid software duplication
+	rm debian/ruby-builder-doc/usr/share/doc/ruby-builder-doc/rdoc/js/jquery.js
+	dh_link -p ruby-builder-doc usr/share/javascript/jquery/jquery.js usr/share/doc/ruby-builder-doc/rdoc/js/jquery.js
+
+override_dh_auto_clean:
+	dh_auto_clean
+	rm -rf build-doc
+

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/ruby-builder.git