Package: virtualenvwrapper
Version: 4.3.1-3

While using virtualenvwrapper, I too periodically went why aren't 
there manpages?

Attached is a patch against the debian git packaging that modifies the 
sphinx documentation to build a man page (and install it for most 
commands).

Diane Trout
>From 0ab5505217848439cd2849c08b397babb111b009 Mon Sep 17 00:00:00 2001
From: Diane Trout <di...@ghic.org>
Date: Mon, 6 Apr 2015 22:33:43 -0700
Subject: [PATCH] Build a man page in addition to the html documentation.

Reusing the sphinx documentation means that I was only really able to
generate a single man page. Since there are many commands provided by
virtualenvwrapper I created a series of symlinks to index all the
commands.

(In a perfect world I would've found a way to generate the list of
links via introspecting sphinx, but this is probably good enough)
---
 debian/patches/manpages.patch  | 13 +++++++++++++
 debian/patches/series          |  1 +
 debian/rules                   |  4 ++++
 debian/virtualenvwrapper.links | 18 ++++++++++++++++++
 4 files changed, 36 insertions(+)
 create mode 100644 debian/patches/manpages.patch
 create mode 100644 debian/virtualenvwrapper.links

diff --git a/debian/patches/manpages.patch b/debian/patches/manpages.patch
new file mode 100644
index 0000000..4976b36
--- /dev/null
+++ b/debian/patches/manpages.patch
@@ -0,0 +1,13 @@
+--- a/docs/source/conf.py
++++ b/docs/source/conf.py
+@@ -203,3 +203,10 @@
+ 
+ # If false, no module index is generated.
+ # latex_use_modindex = True
++
++# -- Options for Man Page output ----------------------------------------------
++man_pages = [
++    ('command_ref', 'virtualenvwrapper',
++     'a set of wrappers to assist with manage your python virtualenvs',
++     [], '1'),
++]
diff --git a/debian/patches/series b/debian/patches/series
index f4d315c..7a74c78 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1,3 +1,4 @@
 remove_bitbucket_support.patch
 fix-python3-sphinx-build.patch
 remove-virtualenvwrapper_lazy-shebang.patch
+manpages.patch
diff --git a/debian/rules b/debian/rules
index c6c3fdf..2156078 100755
--- a/debian/rules
+++ b/debian/rules
@@ -1,5 +1,6 @@
 #!/usr/bin/make -f
 
+VERBOSE=1
 UPSTREAM_VERSION=$(shell dpkg-parsechangelog | sed -n 's/^Version: \([^-]*\).*$$/\1/p')
 export PBR_VERSION=$(UPSTREAM_VERSION)
 export SKIP_PIP_INSTALL=1
@@ -11,6 +12,9 @@ override_dh_auto_clean:
 override_dh_auto_install:
 	sphinx-build -b html -a -c docs/source -D language=en docs/source \
 	    debian/virtualenvwrapper/usr/share/doc/virtualenvwrapper/html
+	sphinx-build -b man -a -c docs/source -D language=en docs/source \
+	    debian/virtualenvwrapper/usr/share/man/man1/
+	rm -r $(CURDIR)/debian/virtualenvwrapper/usr/share/man/man1/.doctrees
 	# python3 build disable because virtualenv3 is not yet available
 	#	python setup.py install --install-layout=deb \
 	#	    --root $(CURDIR)/debian/virtualenvwrapper
diff --git a/debian/virtualenvwrapper.links b/debian/virtualenvwrapper.links
new file mode 100644
index 0000000..b265c3b
--- /dev/null
+++ b/debian/virtualenvwrapper.links
@@ -0,0 +1,18 @@
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/mkvirtualenv.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/mktmpenv.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/lsvirtualenv.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/showvirtualenv.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/rmvirtualenv.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/cpvirtualenv.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/allvirtualenv.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/workon.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/deactivate.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/cdvirtualenv.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/cdsitepackages.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/lssitepackages.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/add2virtualenv.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/toggleglobalsitepackages.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/mkproject.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/setvirtualenvproject.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/cdproject.1.gz
+usr/share/man/man1/virtualenvwrapper.1.gz usr/share/man/man1/wipeenv.1.gz
-- 
2.1.4

Reply via email to