[Python-modules-commits] [python-tornado] 13/14: Added python-tornado-doc package with docs and examples

Ondřej Nový onovy at moszumanska.debian.org
Wed Jul 13 07:21:42 UTC 2016


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

onovy pushed a commit to branch master
in repository python-tornado.

commit d85b1ce409a25ba3652c2f468f481016783c8947
Author: Ondřej Nový <onovy at debian.org>
Date:   Wed Jul 13 09:10:38 2016 +0200

    Added python-tornado-doc package with docs and examples
---
 debian/changelog                                 |  1 +
 debian/control                                   | 18 ++++++++++++++++++
 debian/python-tornado-doc.doc-base               |  9 +++++++++
 debian/{examples => python-tornado-doc.examples} |  0
 debian/python-tornado-doc.links                  |  1 +
 debian/python-tornado-doc.lintian-overrides      | 12 ++++++++++++
 debian/python-tornado.lintian-overrides          |  9 ---------
 debian/rules                                     |  8 +++++++-
 8 files changed, 48 insertions(+), 10 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 8db47e9..7156243 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -16,6 +16,7 @@ python-tornado (4.4.0~b1-1) UNRELEASED; urgency=medium
   * Rearranged Debian tests Depends to Build-Depends
   * Run Py3 unit tests during build and enable verbose mode
   * Bumped required Python version to 2.7 and 3.3
+  * Added python-tornado-doc package with docs and examples
 
  -- Ondřej Nový <novy at ondrej.org>  Mon, 06 Jun 2016 09:30:16 +0200
 
diff --git a/debian/control b/debian/control
index c0646e5..f2c9fd8 100644
--- a/debian/control
+++ b/debian/control
@@ -25,6 +25,8 @@ Build-Depends: ca-certificates,
                python3-pycurl,
                python3-setuptools,
                python3-singledispatch,
+               python3-sphinx,
+               python3-sphinx-rtd-theme,
                python3-twisted,
 Standards-Version: 3.9.8
 Homepage: http://www.tornadoweb.org/
@@ -40,6 +42,7 @@ Depends: ca-certificates,
          ${shlibs:Depends},
 Suggests: python-mysqldb,
           python-pycurl,
+          python-tornado-doc,
           python-twisted,
 Recommends: python-concurrent.futures,
 Description: scalable, non-blocking web server and tools
@@ -58,6 +61,7 @@ Depends: ca-certificates,
          ${python3:Depends},
          ${shlibs:Depends},
 Suggests: python3-pycurl,
+          python-tornado-doc,
           python3-twisted,
 Description: scalable, non-blocking web server and tools - Python 3 package
  Tornado is a Python web framework and asynchronous networking library,
@@ -67,3 +71,17 @@ Description: scalable, non-blocking web server and tools - Python 3 package
  long-lived connection to each user.
  .
  This is the Python 3 version of the package.
+
+Package: python-tornado-doc
+Architecture: all
+Section: doc
+Depends: ${misc:Depends},
+         ${sphinxdoc:Depends},
+Description: scalable, non-blocking web server and tools - documentation
+ Tornado is a Python web framework and asynchronous networking library,
+ originally developed at FriendFeed. By using non-blocking network I/O,
+ Tornado can scale to tens of thousands of open connections, making it ideal
+ for long polling, WebSockets, and other applications that require a
+ long-lived connection to each user.
+ .
+ This package contains the documentation.
diff --git a/debian/python-tornado-doc.doc-base b/debian/python-tornado-doc.doc-base
new file mode 100644
index 0000000..95549fd
--- /dev/null
+++ b/debian/python-tornado-doc.doc-base
@@ -0,0 +1,9 @@
+Document: python-tornado
+Title: Python Tornado Documentation
+Author: The Tornado Authors
+Abstract: This documentation gives an introduction to Python Tornado.
+Section: Programming/Python
+
+Format: HTML
+Index: /usr/share/doc/python-tornado-doc/html/index.html
+Files: /usr/share/doc/python-tornado-doc/html/*.html
diff --git a/debian/examples b/debian/python-tornado-doc.examples
similarity index 100%
rename from debian/examples
rename to debian/python-tornado-doc.examples
diff --git a/debian/python-tornado-doc.links b/debian/python-tornado-doc.links
new file mode 100644
index 0000000..c907c89
--- /dev/null
+++ b/debian/python-tornado-doc.links
@@ -0,0 +1 @@
+usr/share/doc/python-tornado-doc/html/_sources usr/share/doc/python-tornado-doc/rst
diff --git a/debian/python-tornado-doc.lintian-overrides b/debian/python-tornado-doc.lintian-overrides
new file mode 100644
index 0000000..1661b9e
--- /dev/null
+++ b/debian/python-tornado-doc.lintian-overrides
@@ -0,0 +1,12 @@
+# examples on how to use google appengine and blogs, communication with the web is expected
+python-tornado-doc binary: privacy-breach-uses-embedded-file
+python-tornado-doc binary: privacy-breach-generic
+# examples on how to connect to facebook are expected to connect to the web
+python-tornado-doc: privacy-breach-facebook usr/share/doc/python-tornado-doc/examples/facebook/templates/modules/post.html (//graph.facebook.com/{{ escape(post[)
+# examples, so duplication shouldn't be a problem
+python-tornado-doc: duplicate-files usr/share/doc/python-tornado-doc/examples/appengine/templates/archive.html usr/share/doc/python-tornado-doc/examples/blog/templates/archive.html
+python-tornado-doc: duplicate-files usr/share/doc/python-tornado-doc/examples/appengine/templates/entry.html usr/share/doc/python-tornado-doc/examples/blog/templates/entry.html
+python-tornado-doc: duplicate-files usr/share/doc/python-tornado-doc/examples/appengine/templates/feed.xml usr/share/doc/python-tornado-doc/examples/blog/templates/feed.xml
+python-tornado-doc: duplicate-files usr/share/doc/python-tornado-doc/examples/appengine/templates/home.html usr/share/doc/python-tornado-doc/examples/blog/templates/home.html
+python-tornado-doc: duplicate-files usr/share/doc/python-tornado-doc/examples/chat/static/chat.css usr/share/doc/python-tornado-doc/examples/websocket/static/chat.css
+python-tornado-doc: duplicate-files usr/share/doc/python-tornado-doc/examples/chat/templates/message.html usr/share/doc/python-tornado-doc/examples/websocket/templates/message.html
diff --git a/debian/python-tornado.lintian-overrides b/debian/python-tornado.lintian-overrides
index df0e492..94bf1b8 100644
--- a/debian/python-tornado.lintian-overrides
+++ b/debian/python-tornado.lintian-overrides
@@ -1,14 +1,5 @@
 # webserver belongs to web (#665854)
 python-tornado binary: wrong-section-according-to-package-name
-# examples on how to use google appengine and blogs, communication with the web is expected
-python-tornado binary: privacy-breach-uses-embedded-file
-python-tornado binary: privacy-breach-generic
-# examples on how to connect to facebook are expected to connect to the web
-python-tornado: privacy-breach-facebook usr/share/doc/python-tornado/examples/facebook/templates/modules/post.html (//graph.facebook.com/{{ escape(post[)
 # test sample, so duplication shouldn't be a problem
 python-tornado: duplicated-compressed-file usr/lib/python2.7/dist-packages/tornado/test/static/sample.xml.bz2
 python-tornado: duplicated-compressed-file usr/lib/python2.7/dist-packages/tornado/test/static/sample.xml.gz
-# examples, so duplication shouldn't be a problem
-python-tornado: duplicate-files usr/share/doc/python-tornado/examples/chat/static/chat.css usr/share/doc/python-tornado/examples/websocket/static/chat.css
-python-tornado: duplicate-files usr/share/doc/python-tornado/examples/appengine/templates/archive.html usr/share/doc/python-tornado/examples/blog/templates/archive.html
-python-tornado: duplicate-files usr/share/doc/python-tornado/examples/chat/templates/message.html usr/share/doc/python-tornado/examples/websocket/templates/message.html
diff --git a/debian/rules b/debian/rules
index 7d12e43..b9a1a6f 100755
--- a/debian/rules
+++ b/debian/rules
@@ -7,10 +7,16 @@ export PYBUILD_TEST_ARGS={interpreter} ./tornado/test/runtests.py --verbose
 export HOME=/tmp
 
 %:
-	dh $@ --with python2,python3 --buildsystem=pybuild
+	dh $@ --with python2,python3,sphinxdoc --buildsystem=pybuild
 
 override_dh_auto_test:
 	PYBUILD_SYSTEM=custom PYTHONPATH=. dh_auto_test
 
 override_dh_compress:
 	dh_compress -X.py
+
+override_dh_sphinxdoc:
+ifeq (,$(findstring nodocs, $(DEB_BUILD_OPTIONS)))
+	sphinx-build -b html docs $(CURDIR)/debian/python-tornado-doc/usr/share/doc/python-tornado-doc/html
+	dh_sphinxdoc
+endif

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



More information about the Python-modules-commits mailing list