[med-svn] [snpomatic] 10/15: add documentation

[Sascha Steinbiss]

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

sascha-guest pushed a commit to branch master
in repository snpomatic.

commit e57d341e557631c48e5ca6a16ad5699db83fad51
Author: Sascha Steinbiss <sascha at steinbiss.name>
Date:   Sat Dec 12 21:39:05 2015 +0000

    add documentation
---
 debian/control  |  3 ++-
 debian/doc-base | 10 ++++++++++
 debian/rules    | 18 ++++++++++++++----
 3 files changed, 26 insertions(+), 5 deletions(-)

diff --git a/debian/control b/debian/control
index 4beb9aa..655eb0b 100644
--- a/debian/control
+++ b/debian/control
@@ -4,7 +4,8 @@ Uploaders: Sascha Steinbiss <sascha at steinbiss.name>
 Section: science
 Priority: optional
 Build-Depends: debhelper (>= 9),
-               ruby-ronn
+               ruby-ronn,
+               antiword
 Standards-Version: 3.9.6
 Vcs-Browser: https://anonscm.debian.org/cgit/debian-med/fastaq.git
 Vcs-Git: git://anonscm.debian.org/debian-med/snpomatic.git
diff --git a/debian/doc-base b/debian/doc-base
new file mode 100644
index 0000000..626c242
--- /dev/null
+++ b/debian/doc-base
@@ -0,0 +1,10 @@
+Document: snpomatic
+Title: SNP-o-matic manual
+Author: SNP-o-matic authors
+Abstract: User manual for SNP-o-matic
+ These files explain how to use SNP-o-matic, in particular its core executable,
+ findknownsnps.
+Section: Science/Biology
+
+Format: Text
+Files: /usr/share/doc/snpomatic/*.txt.gz
diff --git a/debian/rules b/debian/rules
index 7bd0d33..1c5a6ed 100755
--- a/debian/rules
+++ b/debian/rules
@@ -11,14 +11,24 @@ debfolder := $(CURDIR)/debian
 override_dh_auto_clean:
 	rm -rf debian/findknownsnps.1
 	rm -rf debian/findknownsnps.1.html
+	dh_auto_clean --
+
+override_dh_installdocs:
+	antiword doc/Manual.doc > doc/Manual.txt
+	mkdir -p debian/snpomatic/usr/share/doc/snpomatic
+	cp doc/Manual.txt debian/snpomatic/usr/share/doc/snpomatic
+	mkdir -p debian/snpomatic/usr/share/doc-base
+	cp debian/doc-base debian/snpomatic/usr/share/doc-base/snpomatic-doc
+	dh_installdocs --
 
 override_dh_auto_install:
 	mkdir -p $(debfolder)/snpomatic/usr/bin
 	cp findknownsnps $(debfolder)/snpomatic/usr/bin
-	cp reassemble $(debfolder)/snpomatic/usr/bin
-	cp variety $(debfolder)/snpomatic/usr/bin
-	cp mapcontigs $(debfolder)/snpomatic/usr/bin
-	cp ungap $(debfolder)/snpomatic/usr/bin
+	# -- we don't install the others as they seem unmaintained/undocumented
+	#cp reassemble $(debfolder)/snpomatic/usr/bin
+	#cp variety $(debfolder)/snpomatic/usr/bin
+	#cp mapcontigs $(debfolder)/snpomatic/usr/bin
+	#cp ungap $(debfolder)/snpomatic/usr/bin
 
 override_dh_installman:
 	ronn debian/findknownsnps.1.ronn

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/snpomatic.git