[libfann] 21/133: Added new package libfann2-doc

[Christian Kastner]

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

chrisk-guest pushed a commit to branch master
in repository libfann.

commit 6ca4fa1c4a2c6f98105e6d97b2cd711243becf41
Author: Christian Kastner <debian at kvr.at>
Date:   Mon Jun 7 15:08:20 2010 +0200

    Added new package libfann2-doc
    
    The documentation is generated from the sources using naturaldocs (what
    upstream uses in the Doc package). Also, documentation included previously by
    packagge libfann2 was moved here.
    
    Other packages were made to Recommend or Suggest this.
---
 debian/changelog               |  7 +++++++
 debian/control                 | 29 ++++++++++++++++++++++++++---
 debian/libfann2-doc.docs       |  5 +++++
 debian/{docs => libfann2.docs} |  2 --
 debian/rules                   |  7 +++++++
 5 files changed, 45 insertions(+), 5 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 9403990..327c5d6 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -13,14 +13,21 @@ libfann2 (2.1.0~beta~dfsg-1) UNRELEASED; urgency=low
     - Build-Depend on debhelper (> 7.0.50~) and add ${misc:Depends}
     - Added Build-Depends on python-all-dev and python-support for the python
       extension
+    - Added new package libfann2-doc for the API HTML documentation, and make
+      other package Recommend or Suggest it
+    - Added Build-Depends on naturaldocs for API HTML documentation
+    - Removed Build-Depends on docbook-utils (no longer supported by upstream)
   * debian/source/format:
     - Convert to format 3.0 (quilt)
   * debian/rules:
     - Convert to dh syntax
     - Build python extensions for all available python versions
+    - Generate API HTML documentation using naturaldocs
   * libfann2-py:
     - Rename package to Python Policy-conform python-pyfann
     - Removed debhelper helper files no longer needed because of python-support
+  * libfann2-doc:
+    - New package
   * debian/patches:
     - Added 0001-Link-python-pyfann-dynamically-instead-of-statically.patch
     - Added 0002-Link-against-libm.patch (Closes: #558887)
diff --git a/debian/control b/debian/control
index 6196fdd..f1cd8c6 100644
--- a/debian/control
+++ b/debian/control
@@ -4,11 +4,11 @@ Priority: optional
 Maintainer: Christian Kastner <debian at kvr.at>
 Standards-Version: 3.8.4
 Build-Depends:
-    docbook-utils,
     debhelper (>= 7.0.50~),
     python-all-dev,
     python-support (>= 0.90),
-    swig
+    swig,
+    naturaldocs
 
 Package: libfann2
 Section: libs
@@ -17,7 +17,8 @@ Depends:
     ${shlibs:Depends},
     ${misc:Depends}
 Suggests:
-    libfann2-dev (= ${binary:Version})
+    libfann2-dev (= ${binary:Version}),
+    libfann2-doc (= ${binary:Version})
 Description: Fast Artificial Neural Network Library 
  Fast Artificial Neural Network Library is a free open
  source neural network library, which implements multilayer artificial
@@ -37,6 +38,8 @@ Architecture: any
 Depends:
     ${misc:Depends},
     libfann2 (= ${binary:Version})
+Recommends:
+    libfann2-doc (= ${binary:Version})
 Conflicts: libfann1-dev
 Description: Development libraries and header files for FANN
  Fast Artificial Neural Network Library is a free open
@@ -76,3 +79,23 @@ Description: Python bindings for FANN
  .
  This package contains the python wrapper for FANN.
 
+Package: libfann2-doc
+Section: doc
+Architecture: all
+Depends:
+    ${misc:Depends}
+Suggests:
+    libfann2-dev (= ${binary:Version})
+Description: API documentation for FANN
+ Fast Artificial Neural Network Library is a free open
+ source neural network library, which implements multilayer artificial
+ neural networks in C with support for both fully connected and
+ sparsely connected networks. Cross-platform execution in both fixed
+ and floating point are supported. It includes a framework for easy
+ handling of training data sets. It is easy to use, versatile, well
+ documented, and fast. A python binding is available, and bindings for
+ PHP, C++, .NET, Python, Delphi, Octave, Ruby, Pure Data and Mathematica
+ can be downloaded from FANN's homepage.
+ .
+ This package contains the API documentation in HTML form and some
+ introductory material in text form.
diff --git a/debian/libfann2-doc.docs b/debian/libfann2-doc.docs
new file mode 100644
index 0000000..764a647
--- /dev/null
+++ b/debian/libfann2-doc.docs
@@ -0,0 +1,5 @@
+doc/html
+doc/advancedusage.txt
+doc/fixedpointusage.txt
+doc/gettingstarted.txt
+doc/theory.txt
diff --git a/debian/docs b/debian/libfann2.docs
similarity index 50%
rename from debian/docs
rename to debian/libfann2.docs
index 84df83f..a016fd6 100644
--- a/debian/docs
+++ b/debian/libfann2.docs
@@ -2,5 +2,3 @@ NEWS
 README
 TODO
 AUTHORS
-doc/fann_en.pdf
-doc/*txt
diff --git a/debian/rules b/debian/rules
index 3d97611..f4cca91 100755
--- a/debian/rules
+++ b/debian/rules
@@ -32,6 +32,10 @@ override_dh_auto_build:
 	for py in $(PYVERS); do \
 		python$$py setup.py build; \
 	done
+	
+	# Build documentation
+	mkdir -p doc/html doc/proj
+	naturaldocs -i src/include -o HTML doc/html -p doc/proj
 
 override_dh_auto_clean:
 	# Perform regular clean process
@@ -39,6 +43,9 @@ override_dh_auto_clean:
 	
 	# Remove python extensions build directory
 	rm -rf python/build
+	
+	# Remove output generated by naturaldocs
+	rm -rf doc/proj doc/html
 
 override_dh_auto_install:
 	# Install python extensions from python/, so dh_pysupport can pick them up

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/libfann.git