[Python-modules-commits] [python-social-auth] 02/02: Add 'python-social-auth-doc' binary package

Tiago Ilieve myhro-guest at moszumanska.debian.org
Thu May 19 16:00:24 UTC 2016 

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

myhro-guest pushed a commit to branch master
in repository python-social-auth.

commit f94ec2ccaa6a38954f89c0fcaba841aba6597dd9
Author: Tiago Ilieve <tiago.myhro at gmail.com>
Date:   Thu May 19 12:55:54 2016 -0300

    Add 'python-social-auth-doc' binary package
---
 debian/changelog                       | 18 +++++++++++++-----
 debian/control                         | 24 ++++++++++++++++++++----
 debian/python-social-auth-doc.doc-base |  9 +++++++++
 debian/python-social-auth-doc.docs     |  1 +
 debian/python-social-auth-doc.links    |  4 ++++
 debian/python-social-auth.docs         |  1 -
 debian/python3-social-auth.docs        |  1 -
 debian/rules                           |  8 +++++---
 8 files changed, 52 insertions(+), 14 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 3d1681f..4437c9b 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -5,16 +5,20 @@ python-social-auth (0.2.19-1) unstable; urgency=medium
 
   [ Tiago Ilieve ]
   * New upstream release.
-  * Add newline at end of file for:
-    - debian/python-social-auth.docs
-    - debian/python3-social-auth.docs
-    - debian/source/options
+  * Add newline at end of file for 'debian/source/options'.
+  * Add 'python-social-auth-doc' binary package with HTML documentation:
+    - Add 'python-social-auth-doc.links' to symlink JavaScript files from
+    'libjs-sphinxdoc'.
+    - Drop 'python-social-auth.docs' and 'python3-social-auth.docs'.
+    - Register its documents with 'doc-base'.
   * debian/clean:
     - Add file, fixing "binary file contents changed" error after building the
       documentation twice.
   * debian/compat: bump from 7 to 9.
   * debian/control:
     - Add myself to Uploaders.
+    - Add 'python-social-auth-doc' as 'python-social-auth' and
+    'python3-social-auth' suggested package.
     - Bump 'Standards-Version' to 3.9.8 (no changes needed).
     - Fix 'duplicate-short-description' lintian warning.
     - Run 'wrap-and-sort'.
@@ -28,8 +32,12 @@ python-social-auth (0.2.19-1) unstable; urgency=medium
     - Remove trailing whitespaces.
     - Sort licenses texts by name.
     - Vertical align multiple files/years.
+  * debian/rules:
+    - Build documentation as HTML instead of text.
+    - Change 'override_dh_installdocs' to 'override_dh_auto_build'.
+    - Remove embedded JS files from documentation.
 
- -- Tiago Ilieve <tiago.myhro at gmail.com>  Fri, 13 May 2016 04:33:16 -0300
+ -- Tiago Ilieve <tiago.myhro at gmail.com>  Thu, 19 May 2016 12:54:30 -0300
 
 python-social-auth (0.2.13-1) unstable; urgency=low
 
diff --git a/debian/control b/debian/control
index 2453a63..0001f70 100644
--- a/debian/control
+++ b/debian/control
@@ -21,8 +21,8 @@ Vcs-Browser: https://anonscm.debian.org/git/python-modules/packages/python-socia
 Package: python-social-auth
 Architecture: all
 Depends: ${misc:Depends},
-         ${python:Depends},
-         ${sphinxdoc:Depends}
+         ${python:Depends}
+Suggests: python-social-auth-doc
 Description: Python social authentication made simple (Python 2)
  Python Social Auth is an easy-to-setup social authentication/registration
  mechanism with support for several frameworks and auth providers.
@@ -36,8 +36,8 @@ Description: Python social authentication made simple (Python 2)
 Package: python3-social-auth
 Architecture: all
 Depends: ${misc:Depends},
-         ${python3:Depends},
-         ${sphinxdoc:Depends}
+         ${python3:Depends}
+Suggests: python-social-auth-doc
 Description: Python social authentication made simple (Python 3)
  Python Social Auth is an easy-to-setup social authentication/registration
  mechanism with support for several frameworks and auth providers.
@@ -47,3 +47,19 @@ Description: Python social authentication made simple (Python 3)
  and to bring support for more frameworks and ORMs.
  .
  This package provides the Python 3.x module.
+
+Package: python-social-auth-doc
+Section: doc
+Architecture: all
+Depends: libjs-sphinxdoc,
+         ${misc:Depends},
+         ${sphinxdoc:Depends}
+Description: Python social authentication made simple (Documentation)
+ Python Social Auth is an easy-to-setup social authentication/registration
+ mechanism with support for several frameworks and auth providers.
+ .
+ Crafted using base code from django-social-auth, it implements a common
+ interface to define new authentication providers from third parties,
+ and to bring support for more frameworks and ORMs.
+ .
+ This package provides the HTML documentation.
diff --git a/debian/python-social-auth-doc.doc-base b/debian/python-social-auth-doc.doc-base
new file mode 100644
index 0000000..322e60c
--- /dev/null
+++ b/debian/python-social-auth-doc.doc-base
@@ -0,0 +1,9 @@
+Document: python-social-auth-doc
+Title: python-social-auth HTML documentation
+Author: Matías Aguirre
+Abstract: HTML documentation for python-social-auth built with Sphinx
+Section: Programming/Python
+
+Format: HTML
+Index: /usr/share/doc/python-social-auth-doc/html/index.html
+Files: /usr/share/doc/python-social-auth-doc/html/*.html
diff --git a/debian/python-social-auth-doc.docs b/debian/python-social-auth-doc.docs
new file mode 100644
index 0000000..dd2636a
--- /dev/null
+++ b/debian/python-social-auth-doc.docs
@@ -0,0 +1 @@
+docs/_build/html/
diff --git a/debian/python-social-auth-doc.links b/debian/python-social-auth-doc.links
new file mode 100644
index 0000000..c3958ff
--- /dev/null
+++ b/debian/python-social-auth-doc.links
@@ -0,0 +1,4 @@
+/usr/share/javascript/sphinxdoc/1.0/doctools.js /usr/share/doc/python-social-auth-doc/html/_static/doctools.js
+/usr/share/javascript/sphinxdoc/1.0/jquery.js /usr/share/doc/python-social-auth-doc/html/_static/jquery.js
+/usr/share/javascript/sphinxdoc/1.0/searchtools.js /usr/share/doc/python-social-auth-doc/html/_static/searchtools.js
+/usr/share/javascript/sphinxdoc/1.0/underscore.js /usr/share/doc/python-social-auth-doc/html/_static/underscore.js
diff --git a/debian/python-social-auth.docs b/debian/python-social-auth.docs
deleted file mode 100644
index 123b700..0000000
--- a/debian/python-social-auth.docs
+++ /dev/null
@@ -1 +0,0 @@
-docs/_build/text/*
diff --git a/debian/python3-social-auth.docs b/debian/python3-social-auth.docs
deleted file mode 100644
index 123b700..0000000
--- a/debian/python3-social-auth.docs
+++ /dev/null
@@ -1 +0,0 @@
-docs/_build/text/*
diff --git a/debian/rules b/debian/rules
index 824b229..dcb734d 100755
--- a/debian/rules
+++ b/debian/rules
@@ -12,6 +12,8 @@ export https_proxy = https://127.0.9.1:9
 %:
 	dh $@ --with python2,python3 --buildsystem=pybuild
 
-override_dh_installdocs:
-	cd docs/ ; $(MAKE) text
-	dh_installdocs
+override_dh_auto_build:
+	dh_auto_build
+	cd docs/ ; $(MAKE) html
+	# Remove JS files that will be symlinked from 'libjs-sphinxdoc':
+	cd docs/_build/html/_static/ ; rm doctools.js jquery.js searchtools.js underscore.js

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

More information about the Python-modules-commits mailing list