[Python-modules-commits] [python-tidylib] 07/11: Split the docs into a separate pytidylib-doc package.

[Dmitry Shachnev]

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

mitya57 pushed a commit to branch master
in repository python-tidylib.

commit 9cd630d8a087102b4aac84d40e5b784cb6d004ab
Author: Dmitry Shachnev <mitya57 at gmail.com>
Date:   Mon Dec 14 20:37:40 2015 +0300

    Split the docs into a separate pytidylib-doc package.
    
    Also use dh_sphinxdoc to symlink JavaScript files in the documentation.
---
 debian/changelog                            |  2 ++
 debian/control                              | 21 ++++++++++++++++++++-
 debian/links                                |  2 --
 debian/{doc-base => pytidylib-doc.doc-base} |  4 ++--
 debian/{docs => pytidylib-doc.docs}         |  1 -
 debian/rules                                | 10 ++++------
 6 files changed, 28 insertions(+), 12 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index c3ce58d..995a92d 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -18,6 +18,8 @@ python-tidylib (0.2.4~dfsg-1) UNRELEASED; urgency=low
     files without source.
   * Switch to pybuild buildsystem and build a python3-tidylib package
     (closes: #756001).
+  * Split the docs into a separate pytidylib-doc package.
+  * Use dh_sphinxdoc to symlink JavaScript files in the documentation.
 
  -- Jakub Wilk <jwilk at debian.org>  Sun, 05 May 2013 18:40:57 +0200
 
diff --git a/debian/control b/debian/control
index 15528a2..ea0f38b 100644
--- a/debian/control
+++ b/debian/control
@@ -17,7 +17,7 @@ Vcs-Browser: https://anonscm.debian.org/cgit/python-modules/packages/python-tidy
 
 Package: python-tidylib
 Architecture: all
-Depends: ${misc:Depends}, ${python:Depends}, libtidy-0.99-0, libjs-jquery, libjs-underscore
+Depends: ${misc:Depends}, ${python:Depends}, libtidy-0.99-0
 Description: Python 2 wrapper for HTML Tidy (tidylib)
  PyTidyLib is a Python package that wraps the HTML Tidy library. This allows
  you, from Python code, to “fix” invalid (X)HTML markup. Some of the library’s
@@ -50,3 +50,22 @@ Description: Python 3 wrapper for HTML Tidy (tidylib)
     which some (X)HTML indenting code overlooks.
  .
  This is the Python 3 version of the module.
+
+Package: pytidylib-doc
+Section: doc
+Architecture: all
+Depends: ${misc:Depends}, ${sphinxdoc:Depends}
+Description: Python wrapper for HTML Tidy (tidylib) documentation
+ PyTidyLib is a Python package that wraps the HTML Tidy library. This allows
+ you, from Python code, to “fix” invalid (X)HTML markup. Some of the library’s
+ many capabilities include:
+ .
+  * Clean up unclosed tags and unescaped characters such as ampersands
+  * Output HTML 4 or XHTML, strict or transitional, and add missing doctypes
+  * Convert named entities to numeric entities, which can then be used in XML
+    documents without an HTML doctype.
+  * Clean up HTML from programs such as Word (to an extent)
+  * Indent the output, including proper (i.e. no) indenting for pre elements,
+    which some (X)HTML indenting code overlooks.
+ .
+ This package contains the built HTML and PDF documentation for PyTidyLib.
diff --git a/debian/links b/debian/links
deleted file mode 100644
index c59a8c7..0000000
--- a/debian/links
+++ /dev/null
@@ -1,2 +0,0 @@
-/usr/share/javascript/jquery/jquery.js usr/share/doc/python-tidylib/html/_static/jquery.js
-/usr/share/javascript/underscore/underscore.js usr/share/doc/python-tidylib/html/_static/underscore.js
diff --git a/debian/doc-base b/debian/pytidylib-doc.doc-base
similarity index 75%
rename from debian/doc-base
rename to debian/pytidylib-doc.doc-base
index 3911b1f..2a5636c 100644
--- a/debian/doc-base
+++ b/debian/pytidylib-doc.doc-base
@@ -7,5 +7,5 @@ Abstract: PyTidyLib is a Python package that wraps the HTML Tidy library.
 Section: Programming/Python
 
 Format: HTML
-Index: /usr/share/doc/python-tidylib/html/index.html
-Files: /usr/share/doc/python-tidylib/html/*.html
+Index: /usr/share/doc/pytidylib-doc/html/index.html
+Files: /usr/share/doc/pytidylib-doc/html/*.html
diff --git a/debian/docs b/debian/pytidylib-doc.docs
similarity index 84%
rename from debian/docs
rename to debian/pytidylib-doc.docs
index ef00701..b99572b 100644
--- a/debian/docs
+++ b/debian/pytidylib-doc.docs
@@ -1,3 +1,2 @@
-README
 debian/html
 debian/latex/pytidylib.pdf
diff --git a/debian/rules b/debian/rules
index 2aa95ce..12ae6f3 100755
--- a/debian/rules
+++ b/debian/rules
@@ -3,20 +3,18 @@
 export PYBUILD_NAME=tidylib
 
 %:
-	dh $@ --with python2,python3 --buildsystem pybuild
+	dh $@ --with python2,python3,sphinxdoc --buildsystem pybuild
 
 override_dh_auto_build:
 	dh_auto_build
 	sphinx-build -b latex docs/rst debian/latex
 	make -C debian/latex all-pdf
 	sphinx-build -b html docs/rst debian/html
-	rm -rf debian/html/_sources/
-	rm -f debian/html/_static/jquery.js
-	rm -f debian/html/._index.html
-	rm -rf debian/html/.doctrees
 
 override_dh_auto_clean:
 	rm -rf debian/html
 	rm -rf debian/latex
-	find docs -name "*.pyc" -exec rm -rf {} +
 	dh_auto_clean
+
+override_dh_installdocs:
+	dh_installdocs -A README

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-tidylib.git