[Pkg-mpd-commits] [python-mpd] 16/19: Add a python-mpd-doc package

Simon McVittie smcv at debian.org
Sun May 22 18:17:09 UTC 2016 

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

smcv pushed a commit to branch debian/experimental
in repository python-mpd.

commit c9cef120ccce795e469c02a74247b3f48af72b9f
Author: Simon McVittie <smcv at debian.org>
Date:   Sat Apr 30 17:42:28 2016 +0100

    Add a python-mpd-doc package
    
      - build HTML documentation using Sphinx
---
 debian/changelog               |  4 +++-
 debian/control                 | 23 +++++++++++++++++++++++
 debian/docs                    |  2 --
 debian/python-mpd-doc.doc-base |  9 +++++++++
 debian/python-mpd-doc.docs     |  1 +
 debian/python-mpd-doc.examples |  2 ++
 debian/python-mpd-doc.install  |  3 +++
 debian/python-mpd-doc.links    |  9 +++++++++
 debian/python-mpd.docs         |  2 --
 debian/python3-mpd.docs        |  2 --
 debian/rules                   | 13 ++++++++++++-
 11 files changed, 62 insertions(+), 8 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index b83089a..fd8e8bf 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -11,7 +11,6 @@ python-mpd (0.5.5-1) UNRELEASED; urgency=medium
     - force pybuild build system, since upstream provides a Makefile which
       we don't want to use here
     - add python3-mpd package
-    - ship documentation
     - add .install files to install everything
   * Run dh_install with --fail-missing to catch mistakes
     - specifically don't install mpd_test.py, not needed
@@ -24,6 +23,9 @@ python-mpd (0.5.5-1) UNRELEASED; urgency=medium
   * Vcs-Git, Vcs-Browser: canonicalize
   * Sort package lists (wrap-and-sort -abst)
   * Add patch to update the version number in the documentation
+  * Add a python-mpd-doc package
+    - build HTML documentation using Sphinx
+    - install examples
 
  -- Simon McVittie <smcv at debian.org>  Sat, 30 Apr 2016 13:43:38 +0100
 
diff --git a/debian/control b/debian/control
index e16aaa5..71a368c 100644
--- a/debian/control
+++ b/debian/control
@@ -7,11 +7,14 @@ Uploaders:
  Simon McVittie <smcv at debian.org>,
 Build-Depends:
  debhelper (>= 9),
+ dh-exec,
  dh-python,
  python-all (>= 2.6.6-3~),
  python-setuptools,
  python3-all,
  python3-setuptools,
+ python3-sphinx,
+ sphinx-common,
 Standards-Version: 3.9.8
 X-Python-Version: >= 2.6
 X-Python3-Version: >= 3.2
@@ -37,6 +40,26 @@ Description: Python MPD client library
  This is the Python 2 version of python-mpd2, a fork of the original
  python-mpd.
 
+Package: python-mpd-doc
+Section: doc
+Architecture: all
+Depends:
+ ${misc:Depends},
+ ${shlibs:Depends},
+ ${sphinxdoc:Depends},
+Suggests:
+ devhelp,
+Breaks:
+ python-mpd (<< 0.5.5-1~),
+Replaces:
+ python-mpd (<< 0.5.5-1~),
+Description: Python MPD client library (documentation)
+ Fast MPD (Music Player Daemon) client library written in pure Python.
+ It was written to be a replacement for python-mpdclient which is a bit
+ outdated and does not perform good in many situations.
+ .
+ This package contains the documentation.
+
 Package: python3-mpd
 Architecture: all
 Depends:
diff --git a/debian/docs b/debian/docs
deleted file mode 100644
index 04c600b..0000000
--- a/debian/docs
+++ /dev/null
@@ -1,2 +0,0 @@
-README.txt
-doc/commands.txt
diff --git a/debian/python-mpd-doc.doc-base b/debian/python-mpd-doc.doc-base
new file mode 100644
index 0000000..7b45a7b
--- /dev/null
+++ b/debian/python-mpd-doc.doc-base
@@ -0,0 +1,9 @@
+Document: python-mpd2
+Title: python-mpd2 Documentation
+Author: Jörg Thalheim
+Abstract: API documentation for the mpd Python module
+Section: Programming/Python
+
+Format: HTML
+Index: /usr/share/doc/python-mpd-doc/html/index.html
+Files: /usr/share/doc/python-mpd-doc/html/*.html /usr/share/doc/python-mpd-doc/html/topics/*.html
diff --git a/debian/python-mpd-doc.docs b/debian/python-mpd-doc.docs
new file mode 100644
index 0000000..a1320b1
--- /dev/null
+++ b/debian/python-mpd-doc.docs
@@ -0,0 +1 @@
+README.rst
diff --git a/debian/python-mpd-doc.examples b/debian/python-mpd-doc.examples
new file mode 100644
index 0000000..0f46e6b
--- /dev/null
+++ b/debian/python-mpd-doc.examples
@@ -0,0 +1,2 @@
+examples/*.py
+examples/*.txt
diff --git a/debian/python-mpd-doc.install b/debian/python-mpd-doc.install
new file mode 100644
index 0000000..a26e0d1
--- /dev/null
+++ b/debian/python-mpd-doc.install
@@ -0,0 +1,3 @@
+doc/_build/html                         usr/share/doc/python-mpd-doc
+doc/topics/*.rst                        usr/share/doc/python-mpd-doc/topics
+usr/share/devhelp/books/python-mpd2
diff --git a/debian/python-mpd-doc.links b/debian/python-mpd-doc.links
new file mode 100644
index 0000000..ea85dea
--- /dev/null
+++ b/debian/python-mpd-doc.links
@@ -0,0 +1,9 @@
+usr/share/doc/python-mpd-doc/README.rst usr/share/doc/python-mpd/README.rst
+usr/share/doc/python-mpd-doc/README.rst usr/share/doc/python3-mpd/README.rst
+usr/share/doc/python-mpd-doc/examples   usr/share/doc/python-mpd/examples
+usr/share/doc/python-mpd-doc/examples   usr/share/doc/python3-mpd/examples
+usr/share/doc/python-mpd-doc/html       usr/share/doc/python-mpd/html
+usr/share/doc/python-mpd-doc/html       usr/share/doc/python3-mpd/html
+usr/share/doc/python-mpd-doc/html/_static usr/share/devhelp/books/python-mpd2/_static
+usr/share/doc/python-mpd-doc/topics     usr/share/doc/python-mpd/topics
+usr/share/doc/python-mpd-doc/topics     usr/share/doc/python3-mpd/topics
diff --git a/debian/python-mpd.docs b/debian/python-mpd.docs
deleted file mode 100644
index a67e98a..0000000
--- a/debian/python-mpd.docs
+++ /dev/null
@@ -1,2 +0,0 @@
-README.rst
-doc/topics/commands.rst
diff --git a/debian/python3-mpd.docs b/debian/python3-mpd.docs
deleted file mode 100644
index a67e98a..0000000
--- a/debian/python3-mpd.docs
+++ /dev/null
@@ -1,2 +0,0 @@
-README.rst
-doc/topics/commands.rst
diff --git a/debian/rules b/debian/rules
index 67b800b..4a6bb3f 100755
--- a/debian/rules
+++ b/debian/rules
@@ -3,13 +3,24 @@
 export PYBUILD_DISABLE=test
 
 %:
-	dh $@  --with python2,python3 --buildsystem=pybuild
+	dh $@  --with python2,python3,sphinxdoc --buildsystem=pybuild
+
+override_dh_auto_build:
+	dh_auto_build
+	make -C doc devhelp
+	# re-compress for reproducibility
+	gunzip doc/_build/devhelp/python-mpd2.devhelp.gz
+	gzip --best --no-name doc/_build/devhelp/python-mpd2.devhelp
+	make -C doc html
 
 override_dh_installchangelogs:
 	dh_installchangelogs doc/changes.rst
 
 override_dh_install:
+	install -d debian/tmp/usr/share/devhelp/books
+	cp -a doc/_build/devhelp debian/tmp/usr/share/devhelp/books/python-mpd2
 	rm -f debian/tmp/usr/lib/*/dist-packages/mpd_test.py
 	rm -f debian/tmp/usr/lib/*/dist-packages/*.py[co]
 	rm -fr debian/tmp/usr/lib/*/dist-packages/__pycache__
+	rm -fr debian/tmp/usr/share/devhelp/books/python-mpd2/_static
 	dh_install --fail-missing

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-mpd/python-mpd.git

More information about the Pkg-mpd-commits mailing list