create a simple python package and include the documentation in it so it is installed by default

Author: dhellmann

.hgignore

@@ -5,6 +5,7 @@ paver-minilib.zip
 setup.py
 trace.txt
 docs
+*.pyc
 
 syntax: re
 .DS_Store

MANIFEST.in

@@ -1,7 +1,6 @@
-include README.html
 include setup.py
 include paver-minilib.zip
 include pavement.py
 include tests/*
-recursive-include docs *.html *.txt *.css *.js *.png
+recursive-include virtualenvwrapper *.html *.txt *.css *.js *.png
 recursive-include docsource *.rst

docsource/history.rst

@@ -2,6 +2,10 @@
 Release History
 ===============
 
+1.17
+
+  - Added documentation updates provided by Steve Steiner.
+
 1.16
 
   - Merged in changes to ``cdvirtualenv`` from wam and added tests and docs.

pavement.py

@@ -33,10 +33,10 @@
 # Scan the input for package information
 # to grab any data files (text, images, etc.) 
 # associated with sub-packages.
-# PACKAGE_DATA = paver.setuputils.find_package_data(PROJECT, 
-#                                                   package=PROJECT,
-#                                                   only_in_packages=True,
-#                                                   )
+PACKAGE_DATA = paver.setuputils.find_package_data(PROJECT, 
+                                              package=PROJECT,
+                                              only_in_packages=False,
+                                              )
 
 options(
     setup=Bunch(
@@ -68,13 +68,9 @@
         provides=['virtualenvwrapper',
                   ],
         requires=['virtualenv'],
-
-        data_files=[('docs', ['README.html']),
-                    ],
-
-        # It seems wrong to have to list recursive packages explicitly.
-        # packages = sorted(PACKAGE_DATA.keys()),
-        # package_data=PACKAGE_DATA,
+        
+        packages = sorted(PACKAGE_DATA.keys()),
+        package_data = PACKAGE_DATA,
 
         zip_safe=False,
 
@@ -109,23 +105,26 @@ def remake_directories(*dirnames):
     return
 
 @task
-@needs(['html', 'readme_html', 'generate_setup', 'minilib', 
-        'setuptools.command.sdist'
+@needs('paver.doctools.html')
+def html(options):
+    destdir = path(PROJECT) / 'docs'
+    destdir.rmtree()
+    builtdocs = path(options.builddir) / "html"
+    builtdocs.move(destdir)
+    return
+
+@task
+@needs(['html',
+        'generate_setup', 'minilib', 
+        'setuptools.command.sdist',
         ])
-def sdist():
+def sdist(options):
     """Create a source distribution.
     """
     pass
-
-@task
-def readme_html():
-    # FIXME - Switch to sphinx?
-    outfile = path('README.html')
-    outfile.unlink()
-    sh('rst2html.py %s README.html' % README_FILE)
-    return
-
+    
 @task
 def test():
     sh('bash ./tests/test.sh')
     sh('SHUNIT_PARENT=./tests/test.sh zsh -o shwordsplit ./tests/test.sh')
+    return

virtualenvwrapper/__init__.py

@@ -0,0 +1,11 @@
+"""virtualenvwrapper module
+"""
+
+if __name__ == '__main__':
+    import os
+    import webbrowser
+    docs_root = os.path.join(os.path.dirname(__file__), 'docs', 'index.html')
+    webbrowser.open_new('file://' + docs_root)
+else:
+    import warnings
+    warnings.warn('Use virtualenvwrapper_bashrc to set up your shell environment.')