[xmds2] 05/11: Add package xmds2-doc, with HTML and PDF forms of user documentation

[Rafael Laboissière]

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

rlaboiss-guest pushed a commit to branch master
in repository xmds2.

commit e16484de7b1eec0d818d085818ff668b721ea358
Author: Rafael Laboissiere <rafael at laboissiere.net>
Date:   Sat Jan 11 23:42:35 2014 +0100

    Add package xmds2-doc, with HTML and PDF forms of user documentation
---
 .gitignore                         |  1 +
 debian/control                     | 18 ++++++++++++++++++
 debian/copyright                   | 12 ++++++++++++
 debian/xmds2-doc.doc-base          | 22 ++++++++++++++++++++++
 debian/xmds2-doc.docs              |  4 ++++
 debian/xmds2-doc.lintian-overrides |  5 +++++
 6 files changed, 62 insertions(+)

diff --git a/.gitignore b/.gitignore
index 094c5de..1c1087e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,3 +6,4 @@
 /debian/*.debhelper
 /debian/xmds2/
 /debian/xmds-user-data/
+/debian/xmds2-doc/
diff --git a/debian/control b/debian/control
index b7f2f8e..914bf11 100644
--- a/debian/control
+++ b/debian/control
@@ -58,3 +58,21 @@ Description: eXtensible Multi-Dimensional Simulator
  XMDS 2 is a major upgrade rewritten in Python which is faster and far
  more versatile than previous versions, allowing the efficient integration
  of almost any initial value problem on regular domains.
+
+Package: xmds2-doc
+Architecture: all
+Section: doc
+Depends: ${misc:Depends}
+Description: documentation for the eXtensible Multi-Dimensional Simulator
+ XMDS is a code generator that integrates equations, from Ordinary
+ Differential Equations (ODEs) up to stochastic Partial Differential
+ Equations (PDEs). You write them down in human readable form in an
+ XML file, and it goes away and writes and compiles a C++ program that
+ integrates those equations as fast as it can possibly be done in your
+ architecture.
+ .
+ XMDS 2 is a major upgrade rewritten in Python which is faster and far
+ more versatile than previous versions, allowing the efficient integration
+ of almost any initial value problem on regular domains.
+ .
+ This package contains the documentation in HTML and PDF formats.
diff --git a/debian/copyright b/debian/copyright
index 62433b1..0386b2f 100644
--- a/debian/copyright
+++ b/debian/copyright
@@ -28,6 +28,18 @@ License: GPL-2+
  License, version 2, can be found in the file
  `/usr/share/common-licenses/GPL-2'.
 
+Files: admin/userdoc-source/*
+Copyright: 2007-2013 Graham Dennis
+           2007-2013 Joe Hope
+           2007-2013 Mattias Johnsson
+License: GFDL
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU Free Documentation License, Version 1.3 or any
+ later version published by the Free Software Foundation; with no Invariant
+ Sections, no Front-Cover Texts, and no Back-Cover Texts.  A copy of the
+ license is included in the section entitled "GNU Free Documentation
+ License".
+
 Files: xpdeint/includes/dSFMT/dSFMT.c xpdeint/includes/dSFMT/dSFMT.h
 Copyright: 2007, 2008 Mutsuo Saito
            2007, 2008 Makoto Matsumoto
diff --git a/debian/xmds2-doc.doc-base b/debian/xmds2-doc.doc-base
new file mode 100644
index 0000000..ff9ccdd
--- /dev/null
+++ b/debian/xmds2-doc.doc-base
@@ -0,0 +1,22 @@
+Document: xmds2-user-manual
+Title: XMDS2 User Manual
+Author: Graham Dennis, Joe Hope and Mattias Johnsson
+Abstract: The purpose of XMDS2 is to simplify the process of creating
+ simulations that solve systems of initial-value first-order partial and
+ ordinary differential equations. Instead of going through the error-prone
+ process of writing by hand thousands of lines of code, XMDS2 enables many
+ problems to be described in a simple XML format. From this XML description
+ XMDS2 writes a C++ simulation that solves the problem using fast
+ algorithms. Anecdotally, the code generated by XMDS2 is as fast as, or
+ faster than, code hand-written by an expert, but by using XMDS2 the time
+ taken to produce the simulation is significantly reduced.
+Section: Science/Mathematics
+
+Format: HTML
+Index: /usr/share/doc/xmds2-doc/index.html
+Files: /usr/share/doc/xmds2-doc/*.html
+ /usr/share/doc/xmds2-doc/_static/*
+ /usr/share/doc/xmds2-doc/_images/*
+
+Format: PDF
+Files: /usr/share/doc/xmds2-doc/xmds2.pdf.gz
diff --git a/debian/xmds2-doc.docs b/debian/xmds2-doc.docs
new file mode 100644
index 0000000..de41c4c
--- /dev/null
+++ b/debian/xmds2-doc.docs
@@ -0,0 +1,4 @@
+documentation/*.html
+documentation/_static
+documentation/_images
+documentation/latex/xmds2.pdf
diff --git a/debian/xmds2-doc.lintian-overrides b/debian/xmds2-doc.lintian-overrides
new file mode 100644
index 0000000..8f3ef8a
--- /dev/null
+++ b/debian/xmds2-doc.lintian-overrides
@@ -0,0 +1,5 @@
+# These files are included by python-sphinx.  Better letting them as they
+# are instead of creating symlinks to files in libjs-jquery and libjs-underscore
+
+embedded-javascript-library usr/share/doc/xmds2-doc/_static/jquery.js
+embedded-javascript-library usr/share/doc/xmds2-doc/_static/underscore.js

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