Add common doc packagedebian/1.4-1

7 files changed, 58 insertions, 1 deletions

diff --git a/debian/changelog b/debian/changelog
index 63f7ad0..4a2323d 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -9,6 +9,9 @@ python-bleach (1.4-1) unstable; urgency=low
     - Add python*-nose Build-Dependends
   * Packaging license changed to Apache License 2.0
   * Bumped Standards-Version to 3.9.5, no changes needed
+  * Add common doc package
+    - Binary packages suggests this package
+    - Add python*-sphinx to Build-Depends
 
  -- Per Andersson <avtobiff@gmail.com>  Fri, 14 Feb 2014 00:59:20 +0100
 
diff --git a/debian/control b/debian/control
index d1eba3b..b56d50a 100644
--- a/debian/control
+++ b/debian/control
@@ -10,9 +10,11 @@ Build-Depends:
  python3-all,
  python3-nose,
  python3-setuptools,
+ python3-sphinx (>= 1.0.7+dfsg-1~),
  python-all (>= 2.6.6-3~),
  python-nose,
  python-setuptools,
+ python-sphinx (>= 1.0.7+dfsg-1~),
  python3-html5lib,
  python3-six,
  python-html5lib,
@@ -26,6 +28,7 @@ X-Python3-Version: >= 3.2
 Package: python-bleach
 Architecture: all
 Depends: ${misc:Depends}, ${python:Depends}
+Suggests: python-bleach-doc
 Description: whitelist-based HTML-sanitizing library (Python 2)
  Bleach is an HTML sanitizing library that escapes or strips markup and
  attributes based on a white list. Bleach can also linkify text safely,
@@ -46,6 +49,7 @@ Description: whitelist-based HTML-sanitizing library (Python 2)
 Package: python3-bleach
 Architecture: all
 Depends: ${misc:Depends}, ${python3:Depends}
+Suggests: python-bleach-doc
 Description: whitelist-based HTML-sanitizing library (Python 3)
  Bleach is an HTML sanitizing library that escapes or strips markup and
  attributes based on a white list. Bleach can also linkify text safely,
@@ -62,3 +66,24 @@ Description: whitelist-based HTML-sanitizing library (Python 3)
  unbalanced or mis-nested tags.
  .
  This is the Python 3 version of the package.
+
+Package: python-bleach-doc
+Architecture: all
+Section: doc
+Depends: ${misc:Depends}, ${sphinxdoc:Depends}
+Description: whitelist-based HTML-sanitizing library (common documentation)
+ Bleach is an HTML sanitizing library that escapes or strips markup and
+ attributes based on a white list. Bleach can also linkify text safely,
+ applying filters that Django's urlize filter cannot, and optionally setting
+ rel attributes, even on links already in the text.
+ .
+ Bleach is intended for sanitizing text from untrusted sources. If you find
+ yourself jumping through hoops to allow your site administrators to do lots of
+ things, you're probably outside the use cases. Either trust those users, or
+ don't.
+ .
+ Because it relies on html5lib, Bleach is as good as modern browsers at dealing
+ with weird, quirky HTML fragments. And any of Bleach's methods will fix
+ unbalanced or mis-nested tags.
+ .
+ This is the common documentation package.
diff --git a/debian/python-bleach-doc.doc-base b/debian/python-bleach-doc.doc-base
new file mode 100644
index 0000000..5f6ad8a
--- /dev/null
+++ b/debian/python-bleach-doc.doc-base
@@ -0,0 +1,22 @@
+Document: python-bleach-doc
+Title: Debian python-bleach Manual
+Author: James Socol
+Abstract: whitelist-based HTML-sanitizing library
+ Bleach is an HTML sanitizing library that escapes or strips markup and
+ attributes based on a white list. Bleach can also linkify text safely,
+ applying filters that Django's urlize filter cannot, and optionally setting
+ rel attributes, even on links already in the text.
+ .
+ Bleach is intended for sanitizing text from untrusted sources. If you find
+ yourself jumping through hoops to allow your site administrators to do lots of
+ things, you're probably outside the use cases. Either trust those users, or
+ don't.
+ .
+ Because it relies on html5lib, Bleach is as good as modern browsers at dealing
+ with weird, quirky HTML fragments. And any of Bleach's methods will fix
+ unbalanced or mis-nested tags.
+Section: Programming/Python
+
+Format: HTML
+Index: /usr/share/doc/python-bleach-doc/html/index.html
+Files: /usr/share/doc/python-bleach-doc/html/*
diff --git a/debian/python-bleach-doc.docs b/debian/python-bleach-doc.docs
new file mode 100644
index 0000000..6d28621
--- /dev/null
+++ b/debian/python-bleach-doc.docs
@@ -0,0 +1 @@
+build/html
diff --git a/debian/python-bleach-doc.links b/debian/python-bleach-doc.links
new file mode 100644
index 0000000..9cb4b6c
--- /dev/null
+++ b/debian/python-bleach-doc.links
@@ -0,0 +1 @@
+usr/share/doc/python-bleach-doc/html/_sources usr/share/doc/python-bleach-doc/rst
diff --git a/debian/python3-bleach.docs b/debian/python3-bleach.docs
new file mode 120000
index 0000000..dd4dd1a
--- /dev/null
+++ b/debian/python3-bleach.docs
@@ -0,0 +1 @@
+python-bleach.docs
\ No newline at end of file
diff --git a/debian/rules b/debian/rules
index e6f8559..480b2cd 100755
--- a/debian/rules
+++ b/debian/rules
@@ -3,7 +3,11 @@
 export PYBUILD_NAME=bleach
 
 %:
-	dh $@ --with python2,python3 --buildsystem=pybuild
+	dh $@ --with python2,python3,sphinxdoc --buildsystem=pybuild
+
+override_dh_auto_build:
+	dh_auto_build -O--buildsystem=pybuild
+	PYTHONPATH=. http_proxy='localhost' sphinx-build -N -bhtml docs/ build/html
 
 override_dh_auto_test:
 	nosetests