[Python-modules-commits] r1812 - in /packages/pudge/trunk/debian: changelog copyright manpages pudge.1 rules

pox-guest at users.alioth.debian.org pox-guest at users.alioth.debian.org
Sat Feb 10 19:32:06 CET 2007 

Author: pox-guest
Date: Sat Feb 10 19:32:06 2007
New Revision: 1812

URL: http://svn.debian.org/wsvn/python-modules/?sc=1&rev=1812
Log:
* Add pudge.1 manpage
* Add rule to generate upstream tarball
* Rename Egg dirname

Added:
    packages/pudge/trunk/debian/manpages
    packages/pudge/trunk/debian/pudge.1
Modified:
    packages/pudge/trunk/debian/changelog
    packages/pudge/trunk/debian/copyright
    packages/pudge/trunk/debian/rules

Modified: packages/pudge/trunk/debian/changelog
URL: http://svn.debian.org/wsvn/python-modules/packages/pudge/trunk/debian/changelog?rev=1812&op=diff
==============================================================================
--- packages/pudge/trunk/debian/changelog (original)
+++ packages/pudge/trunk/debian/changelog Sat Feb 10 19:32:06 2007
@@ -1,4 +1,4 @@
-pudge (0.1.2+svn134-1) UNRELEASED; urgency=low
+pudge (0.1.3~svn134-1) unstable; urgency=low
 
   * Initial release (closes: #410359)
 

Modified: packages/pudge/trunk/debian/copyright
URL: http://svn.debian.org/wsvn/python-modules/packages/pudge/trunk/debian/copyright?rev=1812&op=diff
==============================================================================
--- packages/pudge/trunk/debian/copyright (original)
+++ packages/pudge/trunk/debian/copyright Sat Feb 10 19:32:06 2007
@@ -2,6 +2,7 @@
 Sat, 10 Feb 2007 00:39:31 +0100.
 
 It was downloaded from: http://pudge.lesscode.org/
+(`REVISION=134 ./debian/rules tarball`)
 
 Upstream Author: Ryan Tomayko <rtomayko at gmail.com>
 

Added: packages/pudge/trunk/debian/manpages
URL: http://svn.debian.org/wsvn/python-modules/packages/pudge/trunk/debian/manpages?rev=1812&op=file
==============================================================================
--- packages/pudge/trunk/debian/manpages (added)
+++ packages/pudge/trunk/debian/manpages Sat Feb 10 19:32:06 2007
@@ -1,0 +1,1 @@
+debian/pudge.1

Added: packages/pudge/trunk/debian/pudge.1
URL: http://svn.debian.org/wsvn/python-modules/packages/pudge/trunk/debian/pudge.1?rev=1812&op=file
==============================================================================
--- packages/pudge/trunk/debian/pudge.1 (added)
+++ packages/pudge/trunk/debian/pudge.1 Sat Feb 10 19:32:06 2007
@@ -1,0 +1,99 @@
+.TH PUDGE 1 "February 2007"
+.SH NAME
+pudge \- Generate documentation for Python projects
+.SH SYNOPSIS
+.B pudge
+.RI [OPTIONS]
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+.B pudge
+command.
+.PP
+Its highlights are:
+  * Generate documentation for Python packages, modules, classes, functions, and methods.
+  * Module and Class index hierarchies
+  * Support for Restructured Text in docstrings
+  * Easily apply common free documentation licenses (GNU, CC)
+  * Syntax colored source HTML generation with anchors for line numbers
+  * Generated reference documents link to source for all modules, classes, functions, and methods
+  * Basic Restructured Text document templating (brings external documents into the flow of generated pages)
+  * Support for HTML 4.01 or XHTML 1.0 output
+  * Basic Trac integration (adds Trac project links to navigational elements)
+  * Uses a combination of runtime inspection and Python source code scanning
+  * Extensible and customizable using kid templates
+.SH OPTIONS
+.TP
+\fB\-d\fR, \fB\-\-dest\fR=\fIDIR\fR
+Directory where documentation should be generated.
+.TP
+\fB\-i\fR, \fB\-\-documents\fR=\fIFILE\fR...
+Comma seperated list of files
+.TP
+\fB\-c\fR, \fB\-\-title\fR=\fITEXT\fR
+The title of the documentation set. This is used in
+various places in generated documentation and defaults
+to "Module Reference". If you include a document named
+"index", the title from that document is used.
+.TP
+\fB\-f\fR, \fB\-\-force\fR
+Force creation of documentation files even if source
+files are older or the same age.
+.TP
+\fB\-\-license\fR=\fINAME\fR Include a standard license document. Current options
+are "gnu" for the GNU Free Documentation License and
+"cc" for a Creative Commons Attribution, NonCommercial,
+Copyleft license.
+.TP
+\fB\-x\fR, \fB\-\-xhtml\fR
+Generate XHTML 1.0 instead of HTML 4.01.
+HTML 4.01 is the default due to browser compatibility
+issues with XHTML 1.0.
+.TP
+\fB\-e\fR, \fB\-\-ext\fR=\fITEXT\fR
+The file extension to use when writing (X)HTML files.
+The default is '.html'
+.TP
+\fB\-\-stages\fR=\fILIST\fR
+Specify the list of stages that should be performed.
+This allows only portions of the generation to take
+place. Available stages are: copy, docs, reference,
+index, and source.
+.TP
+\fB\-t\fR, \fB\-\-templates=\fR.. The directory where we should look for templates. See
+the 'pudge.templates' package directory for the default
+template set.
+.TP
+\fB\-\-theme\fR=\fINAME\fR
+The name of a built\-in theme (overrides \fB\-\-templates\fR).
+.TP
+\fB\-\-trac\fR=\fIURL\fR
+Adds navigational links to a Trac site.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Verbose output.
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Shutup unless something important happens.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print this help screen.
+.SH EXAMPLES
+
+Generate documentation for 'foo' to current directory:
+.IP
+\f(CW$ pudge -m foo\fR
+.PP
+Generate documentation for 'foo' module/package and two documents to 'build/doc':
+.IP
+\f(CW$ pudge --modules=foo --documents=docs/guide.rst,docs/reference.rst --dest=build/doc\fR
+.PP
+Generate documentation for the 'foo' module/package and license the work
+under the GNU Free Documentation License:
+.IP
+\f(CW$ pudge --license=gnu --modules=foo\fR
+.SH AUTHOR
+pudge was written by Ryan Tomayko <rtomayko at gmail.com>.
+.PP
+This manual page was written by Piotr Ozarowski <ozarow at gmail.com>,
+for the Debian project (but may be used by others).

Modified: packages/pudge/trunk/debian/rules
URL: http://svn.debian.org/wsvn/python-modules/packages/pudge/trunk/debian/rules?rev=1812&op=diff
==============================================================================
--- packages/pudge/trunk/debian/rules (original)
+++ packages/pudge/trunk/debian/rules Sat Feb 10 19:32:06 2007
@@ -2,8 +2,9 @@
 
 #export DH_VERBOSE=1
 
-DEB_UPSTREAM_VERSION=$(shell dpkg-parsechangelog \
-	| grep ^Version: | cut -d ' ' -f 2 | cut -d '-' -f 1)
+#DEB_UPSTREAM_VERSION=$(shell dpkg-parsechangelog \
+#	| sed -rne 's,^Version: ([^-]+).*,\1,p')
+DEB_UPSTREAM_VERSION=0.1.3dev
 
 PYVERS=$(shell pyversions -vr)
 
@@ -22,12 +23,16 @@
 	python$* setup.py install --root $(CURDIR)/debian/python-pudge
 	# default Python version in hashbang
 	sed -i -e '1s/python.*/python/' debian/python-pudge/usr/bin/pudge
+	# Share Egg dir
+	mv debian/python-pudge/usr/lib/python$*/site-packages/pudge-${DEB_UPSTREAM_VERSION}-py$*.egg-info \
+	   debian/python-pudge/usr/lib/python$*/site-packages/pudge-${DEB_UPSTREAM_VERSION}.egg-info
 
 binary-indep: install
 	dh_testdir -i
 	dh_testroot -i
 	dh_installchangelogs -i
 	dh_installdocs -i
+	dh_installman -i
 	dh_pycentral -i
 	dh_compress -i -X.py
 	dh_fixperms -i
@@ -40,4 +45,16 @@
 
 binary: binary-indep binary-arch
 
+tarball:
+	@if [ "$$REVISION" = "" ]; then \
+		REVISION=`LC_ALL=C svn --non-interactive info svn://lesscode.org/pudge/trunk/ \
+			| grep Revision | cut -c 11-`; \
+	fi; \
+	if [ "$$REVISION" = "" ]; then exit 1; fi; \
+        svn -q export -r $${REVISION} svn://lesscode.org/pudge/trunk/ pudge-svn$${REVISION}; \
+        VERSION=`grep "__version__ = " pudge-svn$${REVISION}/pudge/__init__.py | cut -d '"' -f 2`; \
+        tar -zcf ../pudge_$$VERSION~svn$${REVISION}.orig.tar.gz pudge-svn$${REVISION}; \
+        rm -rf pudge-svn$${REVISION}; \
+        echo file ../pudge_$$VERSION~svn$${REVISION}.orig.tar.gz successfully created
+
 .PHONY: build clean binary-indep binary-arch binary install

More information about the Python-modules-commits mailing list