[Python-modules-commits] [flask-restful] 02/02: Apply minor changes based on recommendations from ginngs

Jonathan Carter highvoltage-guest at moszumanska.debian.org
Mon Oct 19 08:14:53 UTC 2015


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

highvoltage-guest pushed a commit to branch master
in repository flask-restful.

commit 6c3bad6e7c21ee6c61a0b26aa8eae1ac8115f7e8
Author: Jonathan Carter <jonathan at bluemosh.com>
Date:   Mon Oct 19 10:14:48 2015 +0200

    Apply minor changes based on recommendations from ginngs
---
 debian/changelog                           |  9 +++--
 debian/control                             | 17 ++++++++--
 debian/patches/remove-external-image       | 16 ++-------
 debian/patches/remove-extra-copyright-file | 54 ------------------------------
 debian/patches/remove-vcs-control-files    | 20 -----------
 debian/patches/series                      |  2 --
 debian/patches/skip-bad-test               | 16 ++-------
 debian/python-flask-restful-doc.doc-base   |  9 +++++
 debian/python-flask-restful-doc.examples   |  1 +
 debian/python-flask-restful-doc.install    |  1 +
 debian/python-flask-restful.docs           |  1 +
 debian/rules                               | 11 ++++--
 12 files changed, 48 insertions(+), 109 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 8aad7ca..dd5d802 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,5 +1,10 @@
-flask-restful (0.3.4-1) unstable; urgency=low
+flask-restful (0.3.4-1) unstable; urgency=medium
 
+  [ Graham Inggs ]
+  * Separate docs into their own package, build with sphinxdoc,
+    do not compress examples, doc-base
+
+  [ Jonathan Carter ]
   * Initial release (Closes: #763962)
 
- -- Jonathan Carter <jonathan at ubuntu.com>  Sat, 04 Oct 2014 11:27:07 +0200
+ -- Graham Inggs <graham at nerve.org.za>  Mon, 21 Sep 2015 17:36:11 +0200
diff --git a/debian/control b/debian/control
index 6c1ad2c..aa9b4c8 100644
--- a/debian/control
+++ b/debian/control
@@ -12,6 +12,7 @@ Build-Depends: debhelper (>= 9),
                python-flask,
                python-mock,
                python-nose,
+               python-sphinx,
                python-setuptools,
                python-six,
                python-tz,
@@ -27,8 +28,8 @@ Build-Depends: debhelper (>= 9),
                python3-tz
 Standards-Version: 3.9.6
 Homepage: https://github.com/twilio/flask-restful
-Vcs-Git: git://anonscm.debian.org/python-modules/packages/flask-restful.git
-Vcs-Browser: https://anonscm.debian.org/cgit/python-modules/packages/flask-restful.git
+Vcs-Svn: svn://anonscm.debian.org/python-modules/packages/flask-restful/trunk/
+Vcs-Browser: http://anonscm.debian.org/viewvc/python-modules/packages/flask-restful/trunk/
 
 Package: python-flask-restful
 Architecture: all
@@ -51,3 +52,15 @@ Description: REST API framework for Flask applications (Python3 Module)
  If you are familiar with Flask, Flask-RESTful should be easy to pick up.
  .
  This package provides the module for Python 3.
+
+Package: python-flask-restful-doc
+Section: doc
+Architecture: all
+Depends: ${misc:Depends}, ${python3:Depends}
+Description: REST API framework for Flask applications (Python3 Module)
+ Flask-RESTful is an extension for Flask that adds support for quickly building
+ REST APIs. It is a lightweight abstraction that works with your existing
+ ORM/libraries. Flask-RESTful encourages best practices with minimal setup.
+ If you are familiar with Flask, Flask-RESTful should be easy to pick up.
+ .
+ This package provides the documentation.
diff --git a/debian/patches/remove-external-image b/debian/patches/remove-external-image
index c351b19..d5db6f5 100644
--- a/debian/patches/remove-external-image
+++ b/debian/patches/remove-external-image
@@ -1,20 +1,10 @@
-From c2c97bd854190efed9e7d2425ffcab15bcd4cf8c Mon Sep 17 00:00:00 2001
-From: Jonathan Carter <jonathan at ubuntu.com>
-Date: Sun, 11 Oct 2015 15:52:42 +0200
-Subject: remove externally linked image
-
- Remove an externally linked image that could cause a potential privacy violation.
+Description: remove externally linked image
+ Remove an externally linked image that could cause a potential privacy violation. 
  .
  flask-restful (0.3.3-1) unstable; urgency=low
  .
    * Initial release (Closes: #763962)
-Patch-Name: remove-external-image
----
- docs/_themes/flask_small/layout.html | 2 ++
- 1 file changed, 2 insertions(+)
-
-diff --git a/docs/_themes/flask_small/layout.html b/docs/_themes/flask_small/layout.html
-index aa1716a..4373a0f 100644
+Author: Jonathan Carter <jonathan at ubuntu.com>
 --- a/docs/_themes/flask_small/layout.html
 +++ b/docs/_themes/flask_small/layout.html
 @@ -14,8 +14,10 @@
diff --git a/debian/patches/remove-extra-copyright-file b/debian/patches/remove-extra-copyright-file
deleted file mode 100644
index 13273c3..0000000
--- a/debian/patches/remove-extra-copyright-file
+++ /dev/null
@@ -1,54 +0,0 @@
-From 1f7e47a61a2b1d5c6c3bc30c2ff22aff38a42b0c Mon Sep 17 00:00:00 2001
-From: Jonathan Carter <jonathan at ubuntu.com>
-Date: Sun, 11 Oct 2015 15:52:39 +0200
-Subject: remove extra bsd 3 clause license file
-
-Patch-Name: remove-extra-copyright-file
----
- docs/_themes/LICENSE | 37 -------------------------------------
- 1 file changed, 37 deletions(-)
- delete mode 100644 docs/_themes/LICENSE
-
-diff --git a/docs/_themes/LICENSE b/docs/_themes/LICENSE
-deleted file mode 100644
-index 8daab7e..0000000
---- a/docs/_themes/LICENSE
-+++ /dev/null
-@@ -1,37 +0,0 @@
--Copyright (c) 2010 by Armin Ronacher.
--
--Some rights reserved.
--
--Redistribution and use in source and binary forms of the theme, with or
--without modification, are permitted provided that the following conditions
--are met:
--
--* Redistributions of source code must retain the above copyright
--  notice, this list of conditions and the following disclaimer.
--
--* Redistributions in binary form must reproduce the above
--  copyright notice, this list of conditions and the following
--  disclaimer in the documentation and/or other materials provided
--  with the distribution.
--
--* The names of the contributors may not be used to endorse or
--  promote products derived from this software without specific
--  prior written permission.
--
--We kindly ask you to only use these themes in an unmodified manner just
--for Flask and Flask-related products, not for unrelated projects.  If you
--like the visual style and want to use it for your own projects, please
--consider making some larger changes to the themes (such as changing
--font faces, sizes, colors or margins).
--
--THIS THEME IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
--AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
--IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
--ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
--LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
--CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
--SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
--INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
--CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
--ARISING IN ANY WAY OUT OF THE USE OF THIS THEME, EVEN IF ADVISED OF THE
--POSSIBILITY OF SUCH DAMAGE.
diff --git a/debian/patches/remove-vcs-control-files b/debian/patches/remove-vcs-control-files
deleted file mode 100644
index 712cada..0000000
--- a/debian/patches/remove-vcs-control-files
+++ /dev/null
@@ -1,20 +0,0 @@
-From 07be095c7888d2768ecdfcb26aa02c1f782a35b8 Mon Sep 17 00:00:00 2001
-From: Jonathan Carter <jonathan at ubuntu.com>
-Date: Sun, 11 Oct 2015 15:52:40 +0200
-Subject: remove .gitignore file from package
-
-Patch-Name: remove-vcs-control-files
----
- docs/_themes/.gitignore | 3 ---
- 1 file changed, 3 deletions(-)
- delete mode 100644 docs/_themes/.gitignore
-
-diff --git a/docs/_themes/.gitignore b/docs/_themes/.gitignore
-deleted file mode 100644
-index 66b6e4c..0000000
---- a/docs/_themes/.gitignore
-+++ /dev/null
-@@ -1,3 +0,0 @@
--*.pyc
--*.pyo
--.DS_Store
diff --git a/debian/patches/series b/debian/patches/series
index f5bf67d..a56e3f0 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1,4 +1,2 @@
-remove-extra-copyright-file
-remove-vcs-control-files
 skip-bad-test
 remove-external-image
diff --git a/debian/patches/skip-bad-test b/debian/patches/skip-bad-test
index 713a0da..0b22cd3 100644
--- a/debian/patches/skip-bad-test
+++ b/debian/patches/skip-bad-test
@@ -1,26 +1,16 @@
-From d364e639923341208436c8e5d241218cc0d3d605 Mon Sep 17 00:00:00 2001
-From: Jonathan Carter <jonathan at ubuntu.com>
-Date: Sun, 11 Oct 2015 15:52:41 +0200
-Subject: skip test that is broken
-
+Description: skip test that is broken
  test_accept_no_default_match_q0_not_acceptable will fail until Werkzeug
  version 1.0 is released. Until then, this test is disabled.
  .
  flask-restful (0.3.3-1) unstable; urgency=low
  .
    * Initial release (Closes: #763962)
+Author: Jonathan Carter <jonathan at ubuntu.com>
 Bug-Debian: https://bugs.debian.org/763962
 
-Patch-Name: skip-bad-test
----
- tests/test_accept.py | 20 --------------------
- 1 file changed, 20 deletions(-)
-
-diff --git a/tests/test_accept.py b/tests/test_accept.py
-index 7d78118..1f294e9 100644
 --- a/tests/test_accept.py
 +++ b/tests/test_accept.py
-@@ -121,26 +121,6 @@ class AcceptTestCase(unittest.TestCase):
+@@ -121,26 +121,6 @@
              assert_equals(res.content_type, 'text/plain')
  
  
diff --git a/debian/python-flask-restful-doc.doc-base b/debian/python-flask-restful-doc.doc-base
new file mode 100644
index 0000000..9f4e994
--- /dev/null
+++ b/debian/python-flask-restful-doc.doc-base
@@ -0,0 +1,9 @@
+Document: python-flask-restful
+Title: Flask-RESTful
+Author: Twilio, Inc.
+Abstract: Simple framework for creating REST APIs
+Section: Programming/Python
+
+Format: HTML
+Index: /usr/share/doc/python-flask-restful-doc/html/index.html
+Files: /usr/share/doc/python-flask-restful-doc/html/*.html
diff --git a/debian/python-flask-restful-doc.examples b/debian/python-flask-restful-doc.examples
new file mode 100644
index 0000000..e39721e
--- /dev/null
+++ b/debian/python-flask-restful-doc.examples
@@ -0,0 +1 @@
+examples/*
diff --git a/debian/python-flask-restful-doc.install b/debian/python-flask-restful-doc.install
new file mode 100644
index 0000000..9b69be6
--- /dev/null
+++ b/debian/python-flask-restful-doc.install
@@ -0,0 +1 @@
+docs/_build/html usr/share/doc/python-flask-restful-doc
diff --git a/debian/python-flask-restful.docs b/debian/python-flask-restful.docs
new file mode 100644
index 0000000..b43bf86
--- /dev/null
+++ b/debian/python-flask-restful.docs
@@ -0,0 +1 @@
+README.md
diff --git a/debian/rules b/debian/rules
index c816261..811ff7c 100755
--- a/debian/rules
+++ b/debian/rules
@@ -3,7 +3,12 @@
 export PYBUILD_NAME=flask-restful
 
 %:
-	dh $@ --buildsystem=pybuild --with=python2,python3
+	dh $@ --buildsystem=pybuild --with=python2,python3,sphinxdoc
 
-override_dh_install:
-	dh_install --exclude=gitignore
+override_dh_auto_clean:
+	dh_auto_clean
+	rm -rf $(CURDIR)/docs/_build
+
+override_dh_auto_build:
+	dh_auto_build
+	cd docs; PYTHONPATH=. http_proxy='127.0.0.1:9' make html

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



More information about the Python-modules-commits mailing list