Commits

Doug Hellmann committed 9397c83

move es and ja versions of docs to their own repositories

  • Participants
  • Parent commits e3ff59e

Comments (0)

Files changed (47)

 	@echo "develop        - install development version"
 	@echo "test           - run the test suite"
 	@echo "test-quick     - run the test suite for bash and one version of Python ($(PYTHON26))"
-	@echo "website        - generate web version of the docs"
-	@echo "installwebsite - copy web version of HTML docs up to server"
 
 .PHONY: sdist
 sdist: html
 # Documentation
 .PHONY: html
 html:
-	(cd docs && $(MAKE) html LANGUAGE="en")
-	(cd docs && $(MAKE) html LANGUAGE="es")
-	(cd docs && $(MAKE) html LANGUAGE="ja")
+	(cd docs && $(MAKE) html)
 
 .PHONY: docclean
 docclean:
 	rm -rf docs/build docs/html
 
-# Website copy of documentation
-.PHONY: website
-website: 
-	[ ~/Devel/doughellmann/doughellmann/templates/base.html -nt docs/sphinx/web/templates/base.html ] && (echo "Updating base.html" ; cp ~/Devel/doughellmann/doughellmann/templates/base.html docs/sphinx/web/templates/base.html) || exit 0
-	rm -rf docs/website
-	(cd docs && $(MAKE) html BUILDDIR="website/en" LANGUAGE="en")
-	(cd docs && $(MAKE) html BUILDDIR="website/es" LANGUAGE="es")
-	(cd docs && $(MAKE) html BUILDDIR="website/ja" LANGUAGE="ja")
-
-installwebsite: website
-	(cd docs/website/en && rsync --rsh=ssh --archive --delete --verbose . www.doughellmann.com:/var/www/doughellmann/DocumentRoot/docs/virtualenvwrapper/)
-	(cd docs/website/es && rsync --rsh=ssh --archive --delete --verbose . www.doughellmann.com:/var/www/doughellmann/DocumentRoot/docs/virtualenvwrapper/es/)
-	(cd docs/website/ja && rsync --rsh=ssh --archive --delete --verbose . www.doughellmann.com:/var/www/doughellmann/DocumentRoot/docs/virtualenvwrapper/ja/)
-
 # Register the new version on pypi
 .PHONY: register
 register:

File docs/Makefile

 # Makefile for Sphinx documentation
 #
 
-# If doc language is English you don't need to set this variable
-LANGUAGE      = en
-
 # You can set these variables from the command line.
-SPHINXOPTS    = -c sphinx
+SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = html/$(LANGUAGE)
+BUILDDIR      = build
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d build/$(LANGUAGE)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(LANGUAGE)
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 
-.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
-	@echo "  html      to make standalone HTML files"
-	@echo "  dirhtml   to make HTML files named index.html in directories"
-	@echo "  pickle    to make pickle files"
-	@echo "  json      to make JSON files"
-	@echo "  htmlhelp  to make HTML files and a HTML help project"
-	@echo "  qthelp    to make HTML files and a qthelp project"
-	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-	@echo "  changes   to make an overview of all changed/added/deprecated items"
-	@echo "  linkcheck to check all external links for integrity"
-	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 
 clean:
 	-rm -rf $(BUILDDIR)/*
 
 html:
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)."
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
-# dirhtml:
-# 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
-# 	@echo
-# 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 
-# pickle:
-# 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
-# 	@echo
-# 	@echo "Build finished; now you can process the pickle files."
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 
-# json:
-# 	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
-# 	@echo
-# 	@echo "Build finished; now you can process the JSON files."
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
 
-# htmlhelp:
-# 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
-# 	@echo
-# 	@echo "Build finished; now you can run HTML Help Workshop with the" \
-# 	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
 
-# qthelp:
-# 	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
-# 	@echo
-# 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-# 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-# 	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/virtualenvwrapper.qhcp"
-# 	@echo "To view the help file:"
-# 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/virtualenvwrapper.qhc"
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
 
-# latex:
-# 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-# 	@echo
-# 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
-# 	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
-# 	      "run these through (pdf)latex."
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/virtualenvwrapper.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/virtualenvwrapper.qhc"
 
-# changes:
-# 	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
-# 	@echo
-# 	@echo "The overview file is in $(BUILDDIR)/changes."
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/virtualenvwrapper"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/virtualenvwrapper"
+	@echo "# devhelp"
 
-# linkcheck:
-# 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
-# 	@echo
-# 	@echo "Link check complete; look for any errors in the above output " \
-# 	      "or in $(BUILDDIR)/linkcheck/output.txt."
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 
-# doctest:
-# 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
-# 	@echo "Testing of doctests in the sources finished, look at the " \
-# 	      "results in $(BUILDDIR)/doctest/output.txt."
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

File docs/en/command_ref.rst

-.. Quick reference documentation for virtualenvwrapper command line functions
-    Originally contributed Thursday, May 28, 2009 by Steve Steiner (ssteinerX@gmail.com)
-
-.. _command:
-
-#################
-Command Reference
-#################
-
-All of the commands below are to be used on the Terminal command line.
-
-=====================
-Managing Environments
-=====================
-
-.. _command-mkvirtualenv:
-
-mkvirtualenv
-------------
-
-Create a new environment, in the WORKON_HOME.
-
-Syntax::
-
-    mkvirtualenv [-a project_path] [-i package] [-r requirements_file] [virtualenv options] ENVNAME
-
-All command line options except ``-a``, ``-i``, ``-r``, and ``-h`` are passed
-directly to ``virtualenv``.  The new environment is automatically
-activated after being initialized.
-
-::
-
-    $ workon
-    $ mkvirtualenv mynewenv
-    New python executable in mynewenv/bin/python
-    Installing distribute.............................................
-    ..................................................................
-    ..................................................................
-    done.
-    (mynewenv)$ workon
-    mynewenv
-    (mynewenv)$ 
-
-The ``-a`` option can be used to associate an existing project
-directory with the new environment.
-
-The ``-i`` option can be used to install one or more packages (by
-repeating the option) after the environment is created.
-
-The ``-r`` option can be used to specify a text file listing packages
-to be installed. The argument value is passed to ``pip -r`` to be
-installed.
-
-.. seealso::
-
-   * :ref:`scripts-premkvirtualenv`
-   * :ref:`scripts-postmkvirtualenv`
-   * `requirements file format`_
-
-.. _requirements file format: http://www.pip-installer.org/en/latest/requirement-format.html
-
-.. _command-mktmpenv:
-
-mktmpenv
---------
-
-Create a new virtualenv in the ``WORKON_HOME`` directory.
-
-Syntax::
-
-    mktmpenv [VIRTUALENV_OPTIONS]
-
-A unique virtualenv name is generated.
-
-::
-
-    $ mktmpenv
-    Using real prefix '/Library/Frameworks/Python.framework/Versions/2.7'
-    New python executable in 1e513ac6-616e-4d56-9aa5-9d0a3b305e20/bin/python
-    Overwriting 1e513ac6-616e-4d56-9aa5-9d0a3b305e20/lib/python2.7/distutils/__init__.py 
-    with new content
-    Installing distribute...............................................
-    ....................................................................
-    .................................................................done.
-    This is a temporary environment. It will be deleted when deactivated.
-    (1e513ac6-616e-4d56-9aa5-9d0a3b305e20) $
-
-.. _command-lsvirtualenv:
-
-lsvirtualenv
-------------
-
-List all of the environments.
-
-Syntax::
-
-    lsvirtualenv [-b] [-l] [-h]
-
--b
-  Brief mode, disables verbose output.
--l
-  Long mode, enables verbose output.  Default.
--h
-  Print the help for lsvirtualenv.
-
-.. seealso::
-
-   * :ref:`scripts-get_env_details`
-
-.. _command-showvirtualenv:
-
-showvirtualenv
---------------
-
-Show the details for a single virtualenv.
-
-Syntax::
-
-    showvirtualenv [env]
-
-.. seealso::
-
-   * :ref:`scripts-get_env_details`
-
-.. _command-rmvirtualenv:
-
-rmvirtualenv
-------------
-
-Remove an environment, in the WORKON_HOME.
-
-Syntax::
-
-    rmvirtualenv ENVNAME
-
-You must use :ref:`command-deactivate` before removing the current
-environment.
-
-::
-
-    (mynewenv)$ deactivate
-    $ rmvirtualenv mynewenv
-    $ workon
-    $
-
-.. seealso::
-
-   * :ref:`scripts-prermvirtualenv`
-   * :ref:`scripts-postrmvirtualenv`
-
-.. _command-cpvirtualenv:
-
-cpvirtualenv
-------------
-
-Duplicate an existing virtualenv environment. The source can be an
-environment managed by virtualenvwrapper or an external environment
-created elsewhere.
-
-Syntax::
-
-    cpvirtualenv ENVNAME [TARGETENVNAME]
-
-.. note::
-
-  Target environment name is required for WORKON_HOME
-  duplications. However, target environment name can be ommited for
-  importing external environments. If omitted, the new environment is
-  given the same name as the original.
-
-::
-
-    $ workon 
-    $ mkvirtualenv source
-    New python executable in source/bin/python
-    Installing distribute.............................................
-    ..................................................................
-    ..................................................................
-    done.
-    (source)$ cpvirtualenv source dest
-    Making script /Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/easy_install relative
-    Making script /Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/easy_install-2.6 relative
-    Making script /Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/pip relative
-    Script /Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/postactivate cannot be made relative (it's not a normal script that starts with #!/Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/python)
-    Script /Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/postdeactivate cannot be made relative (it's not a normal script that starts with #!/Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/python)
-    Script /Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/preactivate cannot be made relative (it's not a normal script that starts with #!/Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/python)
-    Script /Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/predeactivate cannot be made relative (it's not a normal script that starts with #!/Users/dhellmann/Devel/virtualenvwrapper/tmp/dest/bin/python)
-    (dest)$ workon 
-    dest
-    source
-    (dest)$ 
-
-.. seealso::
-
-   * :ref:`scripts-precpvirtualenv`
-   * :ref:`scripts-postcpvirtualenv`
-   * :ref:`scripts-premkvirtualenv`
-   * :ref:`scripts-postmkvirtualenv`
-
-==================================
-Controlling the Active Environment
-==================================
-
-.. _command-workon:
-
-workon
-------
-
-List or change working virtual environments
-
-Syntax::
-
-    workon [environment_name]
-
-If no ``environment_name`` is given the list of available environments
-is printed to stdout.
-
-::
-
-    $ workon 
-    $ mkvirtualenv env1
-      New python executable in env1/bin/python
-    Installing distribute.............................................
-    ..................................................................
-    ..................................................................
-    done.
-    (env1)$ mkvirtualenv env2
-    New python executable in env2/bin/python
-    Installing distribute.............................................
-    ..................................................................
-    ..................................................................
-    done.
-    (env2)$ workon 
-    env1
-    env2
-    (env2)$ workon env1
-    (env1)$ echo $VIRTUAL_ENV
-    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env1
-    (env1)$ workon env2
-    (env2)$ echo $VIRTUAL_ENV
-    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env2
-    (env2)$ 
-
-
-.. seealso::
-
-   * :ref:`scripts-predeactivate`
-   * :ref:`scripts-postdeactivate`
-   * :ref:`scripts-preactivate`
-   * :ref:`scripts-postactivate`
-
-.. _command-deactivate:
-
-deactivate
-----------
-
-Switch from a virtual environment to the system-installed version of
-Python.
-
-Syntax::
-
-    deactivate
-
-.. note::
-
-    This command is actually part of virtualenv, but is wrapped to
-    provide before and after hooks, just as workon does for activate.
-
-::
-
-    $ workon 
-    $ echo $VIRTUAL_ENV
-
-    $ mkvirtualenv env1
-    New python executable in env1/bin/python
-    Installing distribute.............................................
-    ..................................................................
-    ..................................................................
-    done.
-    (env1)$ echo $VIRTUAL_ENV
-    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env1
-    (env1)$ deactivate
-    $ echo $VIRTUAL_ENV
-
-    $ 
-
-.. seealso::
-
-   * :ref:`scripts-predeactivate`
-   * :ref:`scripts-postdeactivate`
-
-==================================
-Quickly Navigating to a virtualenv
-==================================
-
-There are two functions to provide shortcuts to navigate into the
-currently-active virtualenv.
-
-cdvirtualenv
-------------
-
-Change the current working directory to ``$VIRTUAL_ENV``.
-
-Syntax::
-
-    cdvirtualenv [subdir]
-
-Calling ``cdvirtualenv`` changes the current working directory to the
-top of the virtualenv (``$VIRTUAL_ENV``).  An optional argument is
-appended to the path, allowing navigation directly into a
-subdirectory.
-
-::
-
-    $ mkvirtualenv env1
-    New python executable in env1/bin/python
-    Installing distribute.............................................
-    ..................................................................
-    ..................................................................
-    done.
-    (env1)$ echo $VIRTUAL_ENV
-    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env1
-    (env1)$ cdvirtualenv
-    (env1)$ pwd
-    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env1
-    (env1)$ cdvirtualenv bin
-    (env1)$ pwd
-    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env1/bin
-
-cdsitepackages
---------------
-
-Change the current working directory to the ``site-packages`` for
-``$VIRTUAL_ENV``.
-
-Syntax::
-
-    cdsitepackages [subdir]
-
-Because the exact path to the site-packages directory in the
-virtualenv depends on the version of Python, ``cdsitepackages`` is
-provided as a shortcut for ``cdvirtualenv
-lib/python${pyvers}/site-packages``. An optional argument is also
-allowed, to specify a directory hierarchy within the ``site-packages``
-directory to change into.
-
-::
-
-    $ mkvirtualenv env1
-    New python executable in env1/bin/python
-    Installing distribute.............................................
-    ..................................................................
-    ..................................................................
-    done.
-    (env1)$ echo $VIRTUAL_ENV
-    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env1
-    (env1)$ cdsitepackages PyMOTW/bisect/
-    (env1)$ pwd
-    /Users/dhellmann/Devel/virtualenvwrapper/tmp/env1/lib/python2.6/site-packages/PyMOTW/bisect
-
-lssitepackages
---------------
-
-Calling ``lssitepackages`` shows the content of the ``site-packages``
-directory of the currently-active virtualenv.
-
-Syntax::
-
-    lssitepackages
-
-::
-
-    $ mkvirtualenv env1
-    New python executable in env1/bin/python
-    Installing distribute.............................................
-    ..................................................................
-    ..................................................................
-    done.
-    (env1)$ $ workon env1
-    (env1)$ lssitepackages 
-    distribute-0.6.10-py2.6.egg     pip-0.6.3-py2.6.egg
-    easy-install.pth                setuptools.pth
-
-===============
-Path Management
-===============
-
-add2virtualenv
---------------
-
-Adds the specified directories to the Python path for the
-currently-active virtualenv.
-
-Syntax::
-
-    add2virtualenv directory1 directory2 ...
-
-Sometimes it is desirable to share installed packages that are not in
-the system ``site-pacakges`` directory and which should not be
-installed in each virtualenv.  One possible solution is to symlink the
-source into the environment ``site-packages`` directory, but it is
-also easy to add extra directories to the PYTHONPATH by including them
-in a ``.pth`` file inside ``site-packages`` using ``add2virtualenv``.
-
-1. Check out the source for a big project, such as Django.
-2. Run: ``add2virtualenv path_to_source``.
-3. Run: ``add2virtualenv``.
-4. A usage message and list of current "extra" paths is printed.
-
-The directory names are added to a path file named
-``virtualenv_path_extensions.pth`` inside the site-packages directory
-for the environment.
-
-*Based on a contribution from James Bennett and Jannis Leidel.*
-
-.. _command-toggleglobalsitepackages:
-
-toggleglobalsitepackages
-------------------------
-
-Controls whether the active virtualenv will access the packages in the
-global Python ``site-packages`` directory.
-
-Syntax::
-
-    toggleglobalsitepackages [-q]
-
-Outputs the new state of the virtualenv. Use the ``-q`` switch to turn off all
-output.
-
-::
-
-    $ mkvirtualenv env1
-    New python executable in env1/bin/python
-    Installing distribute.............................................
-    ..................................................................
-    ..................................................................
-    done.
-    (env1)$ toggleglobalsitepackages
-    Disabled global site-packages
-    (env1)$ toggleglobalsitepackages
-    Enabled global site-packages
-    (env1)$ toggleglobalsitepackages -q
-    (env1)$
-
-============================
-Project Directory Management
-============================
-
-.. seealso::
-
-   :ref:`project-management`
-
-.. _command-mkproject:
-
-mkproject
----------
-
-Create a new virtualenv in the WORKON_HOME and project directory in
-PROJECT_HOME.
-
-Syntax::
-
-    mkproject [-t template] [virtualenv_options] ENVNAME
-
-The template option may be repeated to have several templates used to
-create a new project.  The templates are applied in the order named on
-the command line.  All other options are passed to ``mkvirtualenv`` to
-create a virtual environment with the same name as the project.
-
-::
-
-    $ mkproject myproj
-    New python executable in myproj/bin/python
-    Installing distribute.............................................
-    ..................................................................
-    ..................................................................
-    done.
-    Creating /Users/dhellmann/Devel/myproj
-    (myproj)$ pwd
-    /Users/dhellmann/Devel/myproj
-    (myproj)$ echo $VIRTUAL_ENV
-    /Users/dhellmann/Envs/myproj
-    (myproj)$ 
-
-.. seealso::
-
-  * :ref:`scripts-premkproject`
-  * :ref:`scripts-postmkproject`
-
-setvirtualenvproject
---------------------
-
-Bind an existing virtualenv to an existing project.
-
-Syntax::
-
-  setvirtualenvproject [virtualenv_path project_path]
-
-The arguments to ``setvirtualenvproject`` are the full paths to the
-virtualenv and project directory.  An association is made so that when
-``workon`` activates the virtualenv the project is also activated.
-
-::
-
-    $ mkproject myproj
-    New python executable in myproj/bin/python
-    Installing distribute.............................................
-    ..................................................................
-    ..................................................................
-    done.
-    Creating /Users/dhellmann/Devel/myproj
-    (myproj)$ mkvirtualenv myproj_new_libs
-    New python executable in myproj/bin/python
-    Installing distribute.............................................
-    ..................................................................
-    ..................................................................
-    done.
-    Creating /Users/dhellmann/Devel/myproj
-    (myproj_new_libs)$ setvirtualenvproject $VIRTUAL_ENV $(pwd)
-
-When no arguments are given, the current virtualenv and current
-directory are assumed.
-
-Any number of virtualenvs can refer to the same project directory,
-making it easy to switch between versions of Python or other
-dependencies for testing.
-
-.. _command-cdproject:
-
-cdproject
----------
-
-Change the current working directory to the one specified as the
-project directory for the active virtualenv.
-
-Syntax::
-
-  cdproject
-

File docs/en/developers.rst

-##############
-For Developers
-##############
-
-If you would like to contribute to virtualenvwrapper directly, these
-instructions should help you get started.  Patches, bug reports, and
-feature requests are all welcome through the `BitBucket site
-<http://bitbucket.org/dhellmann/virtualenvwrapper/>`_.  Contributions
-in the form of patches or pull requests are easier to integrate and
-will receive priority attention.
-
-.. note::
-
-  Before contributing new features to virtualenvwrapper core, please
-  consider whether they should be implemented as an extension instead.
-
-Building Documentation
-======================
-
-The documentation for virtualenvwrapper is written in reStructuredText
-and converted to HTML using Sphinx. The build itself is driven by
-make.  You will need the following packages in order to build the
-docs:
-
-- Sphinx
-- docutils
-
-Once all of the tools are installed into a virtualenv using
-pip, run ``make html`` to generate the HTML version of the
-documentation::
-
-    $ make html
-    rm -rf virtualenvwrapper/docs
-    (cd docs && make html SPHINXOPTS="-c sphinx/pkg")
-    sphinx-build -b html -d build/doctrees  -c sphinx/pkg source build/html
-    Running Sphinx v0.6.4
-    loading pickled environment... done
-    building [html]: targets for 2 source files that are out of date
-    updating environment: 0 added, 2 changed, 0 removed
-    reading sources... [ 50%] command_ref
-    reading sources... [100%] developers
-    
-    looking for now-outdated files... none found
-    pickling environment... done
-    checking consistency... done
-    preparing documents... done
-    writing output... [ 33%] command_ref
-    writing output... [ 66%] developers
-    writing output... [100%] index
-    
-    writing additional files... search
-    copying static files... WARNING: static directory '/Users/dhellmann/Devel/virtualenvwrapper/plugins/docs/sphinx/pkg/static' does not exist
-    done
-    dumping search index... done
-    dumping object inventory... done
-    build succeeded, 1 warning.
-    
-    Build finished. The HTML pages are in build/html.
-    cp -r docs/build/html virtualenvwrapper/docs
-    
-The output version of the documentation ends up in
-``./virtualenvwrapper/docs`` inside your sandbox.
-
-Running Tests
-=============
-
-The test suite for virtualenvwrapper uses shunit2_ and tox_.  The
-shunit2 source is included in the ``tests`` directory, but tox must be
-installed separately (``pip install tox``).
-
-To run the tests under bash, zsh, and ksh for Python 2.4 through 2.7,
-run ``tox`` from the top level directory of the hg repository.
-
-To run individual test scripts, use a command like::
-
-  $ tox tests/test_cd.sh
-
-To run tests under a single version of Python, specify the appropriate
-environment when running tox::
-
-  $ tox -e py27
-
-Combine the two modes to run specific tests with a single version of
-Python::
-
-  $ tox -e py27 tests/test_cd.sh
-
-Add new tests by modifying an existing file or creating new script in
-the ``tests`` directory.
-
-.. _shunit2: http://shunit2.googlecode.com/
-
-.. _tox: http://codespeak.net/tox
-
-.. _developer-templates:
-
-Creating a New Template
-=======================
-
-virtualenvwrapper.project templates work like `virtualenvwrapper
-plugins
-<http://www.doughellmann.com/docs/virtualenvwrapper/plugins.html>`__.
-The *entry point* group name is
-``virtualenvwrapper.project.template``.  Configure your entry point to
-refer to a function that will **run** (source hooks are not supported
-for templates).
-
-The argument to the template function is the name of the project being
-created.  The current working directory is the directory created to
-hold the project files (``$PROJECT_HOME/$envname``).
-
-Help Text
----------
-
-One difference between project templates and other virtualenvwrapper
-extensions is that only the templates specified by the user are run.
-The ``mkproject`` command has a help option to give the user a list of
-the available templates.  The names are taken from the registered
-entry point names, and the descriptions are taken from the docstrings
-for the template functions.

File docs/en/extensions.rst

-=====================
- Existing Extensions
-=====================
-
-Below is a list of some of the extensions available for use with
-virtualenvwrapper.
-
-emacs-desktop
-=============
-
-Emacs desktop-mode_ lets you save the state of emacs (open buffers,
-kill rings, buffer positions, etc.) between sessions.  It can also be
-used as a project file similar to other IDEs.  The emacs-desktop_
-plugin adds a trigger to save the current desktop file and load a new
-one when activating a new virtualenv using ``workon``.
-
-.. _desktop-mode: http://www.emacswiki.org/emacs/DeskTop
-
-.. _emacs-desktop: http://www.doughellmann.com/projects/virtualenvwrapper-emacs-desktop/
-
-.. _extensions-user_scripts:
-
-user_scripts
-============
-
-The ``user_scripts`` extension is delivered with virtualenvwrapper and
-enabled by default.  It implements the user customization script
-features described in :ref:`scripts`.
-
-vim-virtualenv
-==============
-
-`vim-virtualenv`_ is Jeremey Cantrell's plugin for controlling
-virtualenvs from within vim. When used together with
-virtualenvwrapper, vim-virtualenv identifies the virtualenv to
-activate based on the name of the file being edited.
-
-.. _vim-virtualenv: https://github.com/jmcantrell/vim-virtualenv
-
-.. _extensions-templates:
-
-Templates
-=========
-
-Below is a list of some of the templates available for use with
-:ref:`command-mkproject`.
-
-.. _templates-bitbucket:
-
-bitbucket
----------
-
-The bitbucket_ extension automatically clones a mercurial repository
-from the specified bitbucket project.
-
-.. _bitbucket: http://www.doughellmann.com/projects/virtualenvwrapper.bitbucket/
-
-.. _templates-django:
-
-django
-------
-
-The django_ extension automatically creates a new Django project.
-
-.. _django: http://www.doughellmann.com/projects/virtualenvwrapper.django/
-
-.. seealso::
-
-   * :ref:`developer-templates`

File docs/en/history.rst

-===============
-Release History
-===============
-
-dev
-
-  - Switch to stevedore_ for plugin management
-  - mkvirtualenv_help should use ``$VIRTUALENVWRAPPER_PYTHON`` instead
-    of calling ``virtualenv`` directly (:bbissue:`148`).
-  - Fix issue with lazy-loader code under zsh (:bbissue:`144`).
-  - Fix issue with ``noclobber`` option under zsh
-    (:bbissue:`137`). Fix based on patch from :bbuser:`rob_b`.
-
-.. _stevedore: http://pypi.python.org/pypi/stevedore
-
-3.5
-
-  - Rewrite :ref:`command-cpvirtualenv` to use `virtualenv-clone`_
-    instead of making the new environment relocatable. Contributed by
-    Justin Barber (:bbuser:`barberj`). This also resolves a problem
-    with cpvirtualenv not honoring the ``--no-site-packages`` flag
-    (:bbissue:`102`).
-  - Update docs with link to `virtualenvwrapper-win`_ port by David
-    Marble.
-  - Use ``command`` to avoid functions named the same as common
-    utilities. (:bbissue:`119`)
-
-.. _virtualenv-clone: http://pypi.python.org/pypi/virtualenv-clone
-.. _virtualenvwrapper-win: http://pypi.python.org/pypi/virtualenvwrapper-win 
-
-
-3.4
-
-  - Add :ref:`install-lazy-loader` option.
-
-3.3
-
-  - Clean up file permissions and remove shebangs from scripts not
-    intended to be executed on the command line. (contributed by
-    :bbuser:`ralphbean`)
-  - Worked on some brittle tests.
-  - Received updates to Japanese translation of the documentation from
-    :bbuser:`t2y`.
-  - Fix the test script and runner so the user's ``$WORKON_HOME`` is
-    not erased if they do not have some test shells installed.
-    (big thanks to :bbuser:`agriffis`).
-  - If the hook loader is told to list plugins but is not given a hook
-    name, it prints the list of core hooks.
-  - Merge several fixes for path and variable handling for MSYS users
-    from :bbuser:`bwanamarko`. Includes a fix for :bbissue:`138`.
-  - Change :ref:`command-mkvirtualenv` so it catches both ``-h`` and
-    ``--help``.
-  - Fix some issues with the way temporary files are used for hook
-    scripts. (contributed by :bbuser:`agriffis`)
-  - Allow relative path to requirements file with
-    :ref:`command-mkvirtualenv` and ``-r`` option. (:bbuser:`barberj`)
-  - Make whitespace consistent. (:bbuser:`agriffis`)
-
-3.2
-
-  - Make ``project_dir`` a local variable so that
-    :ref:`command-cdproject` does not interfere with other variables
-    the user might have set. (contributed by :bbuser:`slackorama`)
-  - Fix typo in documentation reported by Nick Martin.
-  - Change trove classifier for license "MIT" to reflect the license
-    text presented in the documentation. *This does not indicate a
-    change in the license, just a correction to the expression of that
-    intent. See :ref:`license`* (contributed by :bbuser:`ralphbean` as
-    fix for :bbissue:`134`)
-  - Extend :ref:`command-rmvirtualenv` to allow removing more than one
-    environment at a time. (contributed by :bbuser:`ciberglo`)
-  - Change the definition of
-    ``virtualenvwrapper_get_site_packages_dir`` to ask ``distutils``
-    for the ``site-packages`` directory instead of trying to build the
-    path ourselves in the shell script. This should resolve
-    :bbissue:`112` and improve support for Python interpreters other
-    than C Python. Thanks to Carl Meyer and Dario Bertini for their
-    contributions toward the fix.
-
-3.1
-
-  - Fix a problem with activation hooks when associating a new
-    virtualenv with an existing project directory. (:bbissue:`122`)
-  - Fix a problem with :ref:`command-add2virtualenv` and paths
-    containing "special" characters such as ``&``. (:bbissue:`132`)
-
-3.0.1
-
-  - Fix some packaging issues that made it more difficult to run the
-    tests directly from the sdist package. (:bbissue:`126`)
-
-3.0
-
-  - Add Python 3 support, thanks in large part to the efforts of
-    Daniel Kraus (:bbuser:`dakra`). Tested under Python 2.6, 2.7, and
-    3.2.
-
-2.11.1
-
-  - Remove the initialization shortcut because it breaks tab
-    completion in sub-shell environments like screen and
-    tmux. (:bbissue:`121`)
-
-2.11
-
-  - Add ``-a`` option to :ref:`command-mkvirtualenv` to associate a
-    new virtualenv with an existing project directory. Contributed by
-    Mike Fogel (:bbuser:`mfogel`).
-  - Drops support for Python 2.4 and 2.5. The tools may still work,
-    but I no longer have a development environment set up for testing
-    them, so I do not officially support them.
-  - Shortcut initialization if it has run before.
-  - Set hook log file permissions to be group-writable. (:bbissue:`62`
-    reported by :bbuser:`hedgeddown`)
-  - Add ``VIRTUALENVWRAPPER_PROJECT_FILENAME`` variable so the
-    ``.project`` file used to link a virtualenv to a project can be
-    renamed to avoid conflicts with other tools. (:bbissue:`120`
-    reported by :bbuser:`arthuralvim`)
-
-2.10.1
-
-  - Changed arguments to :ref:`command-mktmpenv` so it always creates
-    an environment name for you. (:bbissue:`114` reported by
-    :bbuser:`alex_gaynor`)
-
-2.10
-
-  - Incorporated patch to add ``-d`` option to
-    :ref:`command-add2virtualenv`, contributed by :bbuser:`miracle2k`.
-  - Add ``-i`` option to :ref:`command-mkvirtualenv`.
-  - Add :ref:`command-mktmpenv` command for creating temporary
-    environments that are automatically removed when they are
-    deactivated.
-  - Fixed a problem with hook_loader that prevented it from working
-    under Python 2.5 and 2.4.
-  - Fix a problem with the way template names were processed under
-    zsh. (:bbissue:`111`)
-
-2.9
-
-  - Change the shell function shell definition syntax so that ksh will
-    treat typeset-declared variables as local. No kidding.
-  - Merge the "project directory" features of the
-    ``virtualenvwrapper.project`` plugin into the main project, adding
-    :ref:`command-mkproject`, :ref:`command-cdproject`, and
-    :ref:`command-setvirtualenvproject` commands.
-  - Add ``-r`` option to :ref:`command-mkvirtualenv` to install
-    dependencies using a pip requirements file.
-
-2.8
-
-  - Use VIRTUALENVWRAPPER_VIRTUALENV in `cpvirtualenv` (:bbissue:`104`).
-  - Add support for `MSYS <http://www.mingw.org/wiki/MSYS>`_
-    environment under Windows. Contributed by Axel
-    H. (:bbuser:`noirbizarre`).
-
-2.7.2
-
-  - Move setup code for tab completion later in the startup code so
-    all of the needed variables are configured. (:bbissue:`97`)
-  - Expand tab completion for zsh to work for all commands.
-
-2.7.1
-
-  - When testing for WORKON_HOME during startup, dereference any
-    symlink to make sure it is a directory.
-  - Set VIRTUALENVWRAPPER_HOOK_DIR and VIRTUALENV_WRAPPER_LOG DIR in
-    virtualenvwrapper_initialize after WORKON_HOME is set
-    (:bbissue:`94`).
-  - Update the :ref:`install-basic` instructions to be more explicit
-    about needing to install virtualenvwrapper globally (or at least
-    outside of a virtualenv).
-
-2.7
-
-  - Fix problem with space in WORKON_HOME path (:bbissue:`79`).
-  - Fix problem with argument processing in lsvirtualenv under zsh
-    (:bbissue:`86`). Thanks to Nat Williams (:bbuser:`natw`) for the
-    bug report and patch.
-  - If WORKON_HOME does not exist, create it. Patch from Carl Karsten
-    (:bbuser:`CarlFK`). Test updates based on patches from Matt Austin
-    (:bbuser:`maafy6`) and Hugo Lopes Tavares (:bbuser:`hltbra`).
-  - Merge in contributions from Paul McLanahan (:bbuser:`pmclanahan`)
-    to fix the test harness to ensure that the test scripts are
-    actually running under the expected shell.
-  - Merge in new shell command :ref:`command-toggleglobalsitepackages`
-    from Paul McLanahan (:bbuser:`pmclanahan`). The new command
-    changes the configuration of the active virtualenv to enable or
-    disable the global ``site-packages`` directory.
-  - Fixed some tests that were failing under ksh on Ubuntu 10.10.
-  - Document the :ref:`VIRTUALENVWRAPPER_VIRTUALENV
-    <variable-VIRTUALENVWRAPPER_VIRTUALENV>` variable.
-  - Implement suggestion by Van Lindberg to have
-    :ref:`VIRTUALENVWRAPPER_HOOK_DIR
-    <variable-VIRTUALENVWRAPPER_HOOK_DIR>` and
-    :ref:`VIRTUALENVWRAPPER_LOG_DIR
-    <variable-VIRTUALENVWRAPPER_LOG_DIR>` variables to control the
-    locations of hooks and logs.
-  - Enabled tab completion for :ref:`command-showvirtualenv`
-    (:bbissue:`78`).
-  - Fixed a problem with running :ref:`command-rmvirtualenv` from
-    within the environment being removed (:bbissue:`83`).
-  - Removed use of -e option in calls to grep for better portability
-    (:bbissue:`85`).
-
-2.6.3
-
-  - Hard-code the version information in the setup.py and conf.py
-    scripts. This still doesn't work for http://readthedocs.org, since
-    the doc build needs the sphinxcontrib.bitbucket extension, but
-    will make it easier to transition the docs to another site later.
-
-2.6.2
-
-  - Attempted to make the doc build work with http://readthedocs.org.
-  - Merged in `Japanese translation of the documentation
-    <http://www.doughellmann.com/docs/virtualenvwrapper/ja/>`__ from
-    Tetsuya Morimoto.
-  - Incorporate a suggestion from Ales Zoulek to let the user specify
-    the virtualenv binary through an environment variable
-    (:ref:`VIRTUALENVWRAPPER_VIRTUALENV <variable-VIRTUALENVWRAPPER_VIRTUALENV>`).
-
-2.6.1
-
-  - Fixed virtualenvwrapper_get_python_version (:bbissue:`73`).
-
-2.6
-
-  - Fixed a problem with hook script line endings under Cygwin
-    (:bbissue:`68`).
-  - Updated documentation to include a list of the compatible shells
-    (:ref:`supported-shells`) and Python versions
-    (:ref:`supported-versions`) (:bbissue:`70`).
-  - Fixed installation dependency on virtualenv (:bbissue:`60`).
-  - Fixed the method for determining the Python version so it works
-    under Python 2.4 (:bbissue:`61`).
-  - Converted the test infrastructure to use `tox
-    <http://codespeak.net/tox/index.html>`_ instead of home-grown
-    scripts in the Makefile.
-
-2.5.3
-
-  - Point release uploaded to PyPI during outage on doughellmann.com.
-
-2.5.2
-
-  - Apply patch from Zach Voase to fix :ref:`command-lsvirtualenv`
-    under zsh. Resolves :bbissue:`64`.
-
-2.5.1
-
-  - Make :ref:`command-workon` list brief environment details when run
-    without argument, instead of full details.
-
-2.5
-
-  - Add :ref:`command-showvirtualenv` command.  Modify
-    :ref:`command-lsvirtualenv` to make verbose output the default.
-
-2.4
-
-  - Add :ref:`command-lsvirtualenv` command with ``-l`` option to run
-    :ref:`scripts-get_env_details` hook instead of always running it
-    when :ref:`command-workon` has no arguments.
-
-2.3
-
-  - Added ``get_env_details`` hook.
-
-2.2.2
-
-  - Integrate Fred Palmer's patch to escape more shell commands to
-    avoid aliases.  Resolves :bbissue:`57`.
-  - Fix a problem with egrep argument escaping (:bbissue:`55`).
-  - Fix a problem with running mkvirtualenv without arguments (:bbissue:`56`).
-
-2.2.1
-
-  - Escape ``which`` calls to avoid aliases. Resolves :bbissue:`46`.
-  - Integrate Manuel Kaufmann's patch to unset GREP_OPTIONS before
-    calling grep.  Resolves :bbissue:`51`.
-  - Escape ``$`` in regex to resolve :bbissue:`53`.
-  - Escape ``rm`` to avoid issues with aliases and resolve
-    :bbissue:`50`.
-
-2.2
-
-  - Switched hook loader execution to a form that works with Python
-    2.4 to resolve :bbissue:`43`.
-  - Tested under Python 2.7b1.  See :bbissue:`44`.
-  - Incorporated performance improvements from David Wolever.  See
-    :bbissue:`38`.
-  - Added some debug instrumentation for :bbissue:`35`.
-
-2.1.1
-
-  - Added `Spanish translation for the documentation
-    <http://www.doughellmann.com/docs/virtualenvwrapper/es/>`__ via
-    Manuel Kaufmann's fork at
-    http://bitbucket.org/humitos/virtualenvwrapper-es-translation/
-  - Fixed improper use of python from ``$PATH`` instead of the
-    location where the wrappers are installed.  See :bbissue:`41`.
-  - Quiet spurrious error/warning messages when deactivating a
-    virtualenv under zsh.  See :bbissue:`42`.
-
-2.1
-
-  - Add support for ksh.  Thanks to Doug Latornell for doing the
-    research on what needed to be changed.
-  - Test import of virtualenvwrapper.hook_loader on startup and report
-    the error in a way that should help the user figure out how to fix
-    it (:bbissue:`33`).
-  - Update :ref:`command-mkvirtualenv` documentation to include the
-    fact that a new environment is activated immediately after it is
-    created (:bbissue:`30`).
-  - Added hooks around :ref:`command-cpvirtualenv`.
-  - Made deactivation more robust, especially under ksh.
-  - Use Python's ``tempfile`` module for creating temporary filenames
-    safely and portably.
-  - Fix a problem with ``virtualenvwrapper_show_workon_options`` that
-    caused it to show ``*`` as the name of a virtualenv when no
-    environments had yet been created.
-  - Change the hook loader so it can be told to run only a set of
-    named hooks.
-  - Add support for listing the available hooks, to be used in help
-    output of commands like virtualenvwrapper.project's mkproject.
-  - Fix mkvirtualenv -h option behavior.
-  - Change logging so the $WORKON_HOME/hook.log file rotates after
-    10KiB.
-
-2.0.2
-
-  - Fixed :bbissue:`32`, making virtualenvwrapper.user_scripts compatible
-    with Python 2.5 again.
-
-2.0.1
-
-  - Fixed :bbissue:`29`, to use a default value for ``TMPDIR`` if it
-    is not set in the user's shell environment.
-
-2.0
-
-  - Rewrote hook management using Distribute_ entry points to make it
-    easier to share extensions.
-
-.. _Distribute: http://packages.python.org/distribute/
-
-1.27
-  
-  - Added cpvirtualenv command [Thomas Desvenain]
-
-1.26
-
-  - Fix a problem with error messages showing up during init for users
-    with the wrappers installed site-wide but who are not actually
-    using them.  See :bbissue:`26`.
-  - Split up the tests into multiple files.
-  - Run all tests with all supported shells.
-
-1.25
-
-  - Merged in changes to cdsitepackages from William McVey.  It now
-    takes an argument and supports tab-completion for directories
-    within site-packages.
-
-1.24.2
-
-  - Add user provided :ref:`tips-and-tricks` section.
-  - Add link to Rich Leland's screencast to :ref:`references` section.
-
-1.24.1
-
-  - Add license text to the header of the script.
-
-1.24
-
-  - Resolve a bug with the preactivate hook not being run properly.
-    Refer to :bbissue:`21` for complete details.
-
-1.23
-
-  - Resolve a bug with the postmkvirtualenv hook not being run
-    properly.  Refer to :bbissue:`19` and :bbissue:`20` for complete
-    details.
-
-1.22
-
-  - Automatically create any missing hook scripts as stubs with
-    comments to expose the feature in case users are not aware of it.
-
-1.21
-
-  - Better protection of ``$WORKON_HOME`` does not exist when the
-    wrapper script is sourced.
-
-1.20
-
-  - Incorporate lssitepackages feature from Sander Smits.
-  - Refactor some of the functions that were using copy-and-paste code
-    to build path names.
-  - Add a few tests.
-
-1.19
-
-  - Fix problem with add2virtualenv and relative paths. Thanks to Doug
-    Latornell for the bug report James Bennett for the suggested fix.
-
-1.18.1
-
-  - Incorporate patch from Sascha Brossmann to fix a
-    :bbissue:`15`. Directory normalization was causing ``WORKON_HOME``
-    to appear to be a missing directory if there were control
-    characters in the output of ``pwd``.
-
-1.18
-
-  - Remove warning during installation if sphinxcontrib.paverutils is
-    not installed. (:bbissue:`10`)
-  - Added some basic developer information to the documentation.
-  - Added documentation for deactivate command.
-
-1.17
-
-  - Added documentation updates provided by Steve Steiner.
-
-1.16
-
-  - Merged in changes to ``cdvirtualenv`` from wam and added tests and
-    docs.
-  - Merged in changes to make error messages go to stderr, also
-    provided by wam.
-
-1.15
-  - Better error handling in mkvirtualenv.
-  - Remove bogus VIRTUALENV_WRAPPER_BIN variable.
-
-1.14
-  - Wrap the virtualenv version of deactivate() with one that lets us
-    invoke the predeactivate hooks.
-  - Fix virtualenvwrapper_show_workon_options for colorized versions
-    of ls and write myself a note so I don't break it again later.
-  - Convert test.sh to use true tests with `shunit2
-    <http://shunit2.googlecode.com/>`_
-
-1.13
-
-  - Fix :bbissue:`5` by correctly handling symlinks and limiting the
-    list of envs to things that look like they can be activated.
-
-1.12
-
-  - Check return value of virtualenvwrapper_verify_workon_home
-    everywhere, thanks to Jeff Forcier for pointing out the errors.
-  - Fix instructions at top of README, pointed out by Matthew Scott.
-  - Add cdvirtualenv and cdsitepackages, contributed by James Bennett.
-  - Enhance test.sh.
-
-1.11
-
-  - Optimize virtualenvwrapper_show_workon_options.
-  - Add global postactivate hook.
-
-1.10
-
-  - Pull in fix for colorized ls from Jeff Forcier
-    (:bbchangeset:`b42a25f7b74a`).
-
-1.9
-
-  - Add more hooks for operations to run before and after creating or
-    deleting environments based on changes from Chris Hasenpflug.
-
-1.8.1
-
-  - Corrected a problem with change to mkvirtualenv that lead to
-    release 1.8 by using an alternate fix proposed by James in
-    comments on release 1.4.
-
-1.8
-
-  - Fix for processing the argument list in mkvirtualenv from
-    jorgevargas (:bbissue:`1`)
-
-1.7
-
-  - Move to bitbucket.org for hosting
-  - clean up TODO list and svn keywords
-  - add license section below
-
-1.6.1
-
-  - More zsh support (fixes to rmvirtualenv) from Byron Clark.
-
-1.6
-
-  - Add completion support for zsh, courtesy of Ted Leung.
-
-1.5
-
-  - Fix some issues with spaces in directory or env names.  They still
-    don't really work with virtualenv, though.
-  - Added documentation for the postactivate and predeactivate scripts.
-
-1.4
-
-  - Includes a new .pth management function based on work contributed
-    by James Bennett and Jannis Leidel.
-
-1.3.x
-
-  - Includes a fix for a nasty bug in rmvirtualenv identified by John Shimek.

File docs/en/hooks.rst

-===============================
- Customizing Virtualenvwrapper
-===============================
-
-virtualenvwrapper adds several hook points you can use to change your
-settings, shell environment, or other configuration values when
-creating, deleting, or moving between environments. These hooks are
-exposed in two ways:
-
-.. toctree::
-   :maxdepth: 1
-
-   scripts
-   plugins

File docs/en/index.rst

-.. virtualenvwrapper documentation master file, created by
-   sphinx-quickstart on Thu May 28 22:35:13 2009.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-###########################
-virtualenvwrapper |release|
-###########################
-
-virtualenvwrapper is a set of extensions to Ian Bicking's `virtualenv
-<http://pypi.python.org/pypi/virtualenv>`_ tool.  The extensions
-include wrappers for creating and deleting virtual environments and
-otherwise managing your development workflow, making it easier to work
-on more than one project at a time without introducing conflicts in
-their dependencies.
-
-========
-Features
-========
-
-1. Organizes all of your virtual environments in one place.
-2. Wrappers for managing your virtual environments (create, delete,
-   copy).
-3. Use a single command to switch between environments.
-4. Tab completion for commands that take a virtual environment as
-   argument.
-5. User-configurable hooks for all operations (see :ref:`scripts`).
-6. Plugin system for more creating sharable extensions (see
-   :ref:`plugins`).
-
-============
-Introduction
-============
-
-The best way to explain the features virtualenvwrapper gives you is to
-show it in use.
-
-First, some initialization steps.  Most of this only needs to be done
-one time.  You will want to add the command to ``source
-/usr/local/bin/virtualenvwrapper.sh`` to your shell startup file,
-changing the path to virtualenvwrapper.sh depending on where it was
-installed by pip.
-
-::
-
-  $ pip install virtualenvwrapper
-  ...
-  $ export WORKON_HOME=~/Envs
-  $ mkdir -p $WORKON_HOME
-  $ source /usr/local/bin/virtualenvwrapper.sh
-  $ mkvirtualenv env1
-  Installing
-  distribute..........................................
-  ....................................................
-  ....................................................
-  ...............................done.
-  virtualenvwrapper.user_scripts Creating /Users/dhellmann/Envs/env1/bin/predeactivate
-  virtualenvwrapper.user_scripts Creating /Users/dhellmann/Envs/env1/bin/postdeactivate
-  virtualenvwrapper.user_scripts Creating /Users/dhellmann/Envs/env1/bin/preactivate
-  virtualenvwrapper.user_scripts Creating /Users/dhellmann/Envs/env1/bin/postactivate  New python executable in env1/bin/python
-  (env1)$ ls $WORKON_HOME
-  env1 hook.log
-
-Now we can install some software into the environment.
-
-::
-
-  (env1)$ pip install django
-  Downloading/unpacking django
-    Downloading Django-1.1.1.tar.gz (5.6Mb): 5.6Mb downloaded
-    Running setup.py egg_info for package django
-  Installing collected packages: django
-    Running setup.py install for django
-      changing mode of build/scripts-2.6/django-admin.py from 644 to 755
-      changing mode of /Users/dhellmann/Envs/env1/bin/django-admin.py to 755
-  Successfully installed django
-
-We can see the new package with ``lssitepackages``::
-
-  (env1)$ lssitepackages
-  Django-1.1.1-py2.6.egg-info     easy-install.pth
-  distribute-0.6.10-py2.6.egg     pip-0.6.3-py2.6.egg
-  django                          setuptools.pth
-
-Of course we are not limited to a single virtualenv::
-
-  (env1)$ ls $WORKON_HOME
-  env1            hook.log
-  (env1)$ mkvirtualenv env2
-  Installing distribute...............................
-  ....................................................
-  ....................................................
-  ........... ...............................done.
-  virtualenvwrapper.user_scripts Creating /Users/dhellmann/Envs/env2/bin/predeactivate
-  virtualenvwrapper.user_scripts Creating /Users/dhellmann/Envs/env2/bin/postdeactivate
-  virtualenvwrapper.user_scripts Creating /Users/dhellmann/Envs/env2/bin/preactivate
-  virtualenvwrapper.user_scripts Creating /Users/dhellmann/Envs/env2/bin/postactivate  New python executable in env2/bin/python
-  (env2)$ ls $WORKON_HOME
-  env1            env2            hook.log
-
-Switch between environments with ``workon``::
-
-  (env2)$ workon env1
-  (env1)$ echo $VIRTUAL_ENV
-  /Users/dhellmann/Envs/env1
-  (env1)$ 
-
-The ``workon`` command also includes tab completion for the
-environment names, and invokes customization scripts as an environment
-is activated or deactivated (see :ref:`scripts`).
-
-::
-
-  (env1)$ echo 'cd $VIRTUAL_ENV' >> $WORKON_HOME/postactivate
-  (env1)$ workon env2
-  (env2)$ pwd
-  /Users/dhellmann/Envs/env2
-
-:ref:`scripts-postmkvirtualenv` is run when a new environment is
-created, letting you automatically install commonly-used tools.
-
-::
-
-  (env2)$ echo 'pip install sphinx' >> $WORKON_HOME/postmkvirtualenv
-  (env3)$ mkvirtualenv env3
-  New python executable in env3/bin/python
-  Installing distribute...............................
-  ....................................................
-  ....................................................
-  ........... ...............................done.
-  virtualenvwrapper.user_scripts Creating /Users/dhellmann/Envs/env3/bin/predeactivate
-  virtualenvwrapper.user_scripts Creating /Users/dhellmann/Envs/env3/bin/postdeactivate
-  virtualenvwrapper.user_scripts Creating /Users/dhellmann/Envs/env3/bin/preactivate
-  virtualenvwrapper.user_scripts Creating /Users/dhellmann/Envs/env3/bin/postactivate
-  Downloading/unpacking sphinx
-    Downloading Sphinx-0.6.5.tar.gz (972Kb): 972Kb downloaded
-    Running setup.py egg_info for package sphinx
-      no previously-included directories found matching 'doc/_build'
-  Downloading/unpacking Pygments>=0.8 (from sphinx)
-    Downloading Pygments-1.3.1.tar.gz (1.1Mb): 1.1Mb downloaded
-    Running setup.py egg_info for package Pygments
-  Downloading/unpacking Jinja2>=2.1 (from sphinx)
-    Downloading Jinja2-2.4.tar.gz (688Kb): 688Kb downloaded
-    Running setup.py egg_info for package Jinja2
-      warning: no previously-included files matching '*' found under directory 'docs/_build/doctrees'
-  Downloading/unpacking docutils>=0.4 (from sphinx)
-    Downloading docutils-0.6.tar.gz (1.4Mb): 1.4Mb downloaded
-    Running setup.py egg_info for package docutils
-  Installing collected packages: docutils, Jinja2, Pygments, sphinx
-    Running setup.py install for docutils
-    Running setup.py install for Jinja2
-    Running setup.py install for Pygments
-    Running setup.py install for sphinx
-      no previously-included directories found matching 'doc/_build'
-      Installing sphinx-build script to /Users/dhellmann/Envs/env3/bin
-      Installing sphinx-quickstart script to /Users/dhellmann/Envs/env3/bin
-      Installing sphinx-autogen script to /Users/dhellmann/Envs/env3/bin
-  Successfully installed docutils Jinja2 Pygments sphinx  (env3)$ 
-  (venv3)$ which sphinx-build
-  /Users/dhellmann/Envs/env3/bin/sphinx-build
-
-Through a combination of the existing functions defined by the core
-package (see :ref:`command`), third-party plugins (see
-:ref:`plugins`), and user-defined scripts (see :ref:`scripts`)
-virtualenvwrapper gives you a wide variety of opportunities to
-automate repetitive operations.
-
-=======
-Details
-=======
-
-.. toctree::
-   :maxdepth: 2
-
-   install
-   command_ref
-   hooks
-   projects
-   tips
-   developers
-   extensions
-   history
-
-.. _references:
-
-==========
-References
-==========
-
-`virtualenv <http://pypi.python.org/pypi/virtualenv>`_, from Ian
-Bicking, is a pre-requisite to using these extensions.
-
-For more details, refer to the column I wrote for the May 2008 issue
-of Python Magazine: `virtualenvwrapper | And Now For Something
-Completely Different
-<http://www.doughellmann.com/articles/CompletelyDifferent-2008-05-virtualenvwrapper/index.html>`_.
-
-Rich Leland has created a short `screencast
-<http://mathematism.com/2009/jul/30/presentation-pip-and-virtualenv/>`__
-showing off the features of virtualenvwrapper.
-
-Manuel Kaufmann has `translated this documentation into Spanish
-<http://www.doughellmann.com/docs/virtualenvwrapper/es/>`__.
-
-Tetsuya Morimoto has `translated this documentation into Japanese
-<http://www.doughellmann.com/docs/virtualenvwrapper/ja/>`__.
-
-=======
-Support
-=======
-
-Join the `virtualenvwrapper Google Group
-<http://groups.google.com/group/virtualenvwrapper/>`__ to discuss
-issues and features.  
-
-Report bugs via the `bug tracker on BitBucket
-<http://bitbucket.org/dhellmann/virtualenvwrapper/>`__.
-
-Shell Aliases
-=============
-
-Since virtualenvwrapper is largely a shell script, it uses shell
-commands for a lot of its actions.  If your environment makes heavy
-use of shell aliases or other customizations, you may encounter
-issues.  Before reporting bugs in the bug tracker, please test
-*without* your aliases enabled.  If you can identify the alias causing
-the problem, that will help make virtualenvwrapper more robust.
-
-.. _license:
-
-=======
-License
-=======
-
-Copyright Doug Hellmann, All Rights Reserved
-
-Permission to use, copy, modify, and distribute this software and its
-documentation for any purpose and without fee is hereby granted,
-provided that the above copyright notice appear in all copies and that
-both that copyright notice and this permission notice appear in
-supporting documentation, and that the name of Doug Hellmann not be
-used in advertising or publicity pertaining to distribution of the
-software without specific, written prior permission.
-
-DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
-INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
-EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
-CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
-USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.

File docs/en/install.rst

-============
-Installation
-============
-
-.. _supported-shells:
-
-Supported Shells
-================
-
-virtualenvwrapper is a set of shell *functions* defined in Bourne
-shell compatible syntax.  Its automated tests run under these
-shells on OS X and Linux:
-
-* ``bash``
-* ``ksh``
-* ``zsh``
-
-It may work with other shells, so if you find that it does work with a
-shell not listed here please let me know.  If you can modify it to
-work with another shell without completely rewriting it, then send a pull
-request through the `bitbucket project page`_.  If you write a clone to
-work with an incompatible shell, let me know and I will link to it
-from this page.
-
-.. _bitbucket project page: https://bitbucket.org/dhellmann/virtualenvwrapper/
-
-Windows Command Prompt
-----------------------
-
-David Marble has ported virtualenvwrapper to Windows batch scripts,
-which can be run under Microsoft Windows Command Prompt. This is also
-a separately distributed re-implementation. You can download
-`virtualenvwrapper-win`_ from PyPI.
-
-.. _virtualenvwrapper-win: http://pypi.python.org/pypi/virtualenvwrapper-win 
-
-MSYS
-----
-
-It is possible to use virtualenv wrapper under `MSYS
-<http://www.mingw.org/wiki/MSYS>`_ with a native Windows Python
-installation.  In order to make it work, you need to define an extra
-environment variable named ``MSYS_HOME`` containing the root path to
-the MSYS installation.
-
-::
-
-    export WORKON_HOME=$HOME/.virtualenvs
-    export MSYS_HOME=/c/msys/1.0
-    source /usr/local/bin/virtualenvwrapper.sh
-
-or::
-
-    export WORKON_HOME=$HOME/.virtualenvs
-    export MSYS_HOME=C:\msys\1.0
-    source /usr/local/bin/virtualenvwrapper.sh
-
-Depending on your MSYS setup, you may need to install the `MSYS mktemp
-binary`_ in the ``MSYS_HOME/bin`` folder.
-
-.. _MSYS mktemp binary: http://sourceforge.net/projects/mingw/files/MSYS/mktemp/
-
-PowerShell
-----------
-
-Guillermo López-Anglada has ported virtualenvwrapper to run under
-Microsoft's PowerShell. We have agreed that since it is not compatible
-with the rest of the extensions, and is largely a re-implementation
-(rather than an adaptation), it should be distributed separately. You
-can download virtualenvwrapper-powershell_ from PyPI.
-
-.. _virtualenvwrapper-powershell: http://pypi.python.org/pypi/virtualenvwrapper-powershell/2.7.1
-
-.. _supported-versions:
-
-Python Versions
-===============
-
-virtualenvwrapper is tested under Python 2.4 - 2.7.
-
-.. _install-basic:
-
-Basic Installation
-==================
-
-virtualenvwrapper should be installed into the same global
-site-packages area where virtualenv is installed. You may need
-administrative privileges to do that.  The easiest way to install it
-is using pip_::
-
-  $ pip install virtualenvwrapper
-
-or::
-
-  $ sudo pip install virtualenvwrapper
-
-.. warning::
-
-    virtualenv lets you create many different Python environments. You
-    should only ever install virtualenv and virtualenvwrapper on your
-    base Python installation (i.e. NOT while a virtualenv is active)
-    so that the same release is shared by all Python environments that
-    depend on it.
-
-An alternative to installing it into the global site-packages is to
-add it to `your user local directory
-<http://docs.python.org/install/index.html#alternate-installation-the-home-scheme>`__
-(usually `~/.local`).
-
-::
-
-  $ pip install --install-option="--user" virtualenvwrapper
-
-.. _install-shell-config:
-
-Shell Startup File
-==================
-
-Add three lines to your shell startup file (``.bashrc``, ``.profile``,
-etc.) to set the location where the virtual environments should live,
-the location of your development project directories, and the location
-of the script installed with this package::
-
-    export WORKON_HOME=$HOME/.virtualenvs
-    export PROJECT_HOME=$HOME/Devel
-    source /usr/local/bin/virtualenvwrapper.sh
-
-After editing it, reload the startup file (e.g., run ``source
-~/.bashrc``).
-
-.. _install-lazy-loader:
-
-Lazy Loading
-------------
-
-An alternative initialization script is provided for loading
-virtualenvwrapper lazily. Instead of sourcing ``virtualenvwrapper.sh``
-directly, use ``virtualenvwrapper_lazy.sh``. If
-``virtualenvwrapper.sh`` is not on your ``$PATH``, set
-``VIRTUALENVWRAPPER_SCRIPT`` to point to it.
-
-::
-
-    export WORKON_HOME=$HOME/.virtualenvs
-    export PROJECT_HOME=$HOME/Devel
-    export VIRTUALENVWRAPPER_SCRIPT=/usr/local/bin/virtualenvwrapper.sh
-    source /usr/local/bin/virtualenvwrapper_lazy.sh
-
-.. warning::
-
-   When the lazy-loading version of the startup script is used,
-   tab-completion of arguments to virtualenvwrapper commands (such as
-   environment names) is not enabled until after the first command has
-   been run. For example, tab completion of environments does not work
-   for the first instance of :ref:`command-workon`.
-
-Quick-Start
-===========
-
-1. Run: ``workon``
-2. A list of environments, empty, is printed.
-3. Run: ``mkvirtualenv temp``
-4. A new environment, ``temp`` is created and activated.
-5. Run: ``workon``
-6. This time, the ``temp`` environment is included.
-
-Configuration
-=============
-
-virtualenvwrapper can be customized by changing environment
-variables. Set the variables in your shell startup file *before*
-loading ``virtualenvwrapper.sh``.
-
-.. _variable-WORKON_HOME:
-
-Location of Environments
-------------------------
-
-The variable ``WORKON_HOME`` tells virtualenvwrapper where to place
-your virtual environments.  The default is ``$HOME/.virtualenvs``. If
-the directory does not exist when virtualenvwrapper is loaded, it will
-be created automatically.
-
-.. _variable-PROJECT_HOME:
-
-Location of Project Directories
--------------------------------
-
-The variable ``PROJECT_HOME`` tells virtualenvwrapper where to place
-your project working directories.  The variable must be set and the
-directory created before :ref:`command-mkproject` is used.
-
-.. seealso::
-
-   * :ref:`project-management`
-
-.. _variable-VIRTUALENVWRAPPER_PROJECT_FILENAME:
-
-Project Linkage Filename
-------------------------
-
-The variable ``VIRTUALENVWRAPPER_PROJECT_FILENAME`` tells
-virtualenvwrapper how to name the file linking a virtualenv to a
-project working directory. The default is ``.project``.
-
-.. seealso::
-
-   * :ref:`project-management`
-
-.. _variable-VIRTUALENVWRAPPER_HOOK_DIR:
-
-Location of Hook Scripts
-------------------------
-
-The variable ``VIRTUALENVWRAPPER_HOOK_DIR`` tells virtualenvwrapper
-where the :ref:`user-defined hooks <scripts>` should be placed. The
-default is ``$WORKON_HOME``.
-
-.. seealso::
-
-   * :ref:`scripts`
-
-.. _variable-VIRTUALENVWRAPPER_LOG_DIR:
-
-Location of Hook Logs
----------------------
-
-The variable ``VIRTUALENVWRAPPER_LOG_DIR`` tells virtualenvwrapper
-where the logs for the hook loader should be written. The default is
-``$WORKON_HOME``.
-
-.. _variable-VIRTUALENVWRAPPER_VIRTUALENV:
-
-.. _variable-VIRTUALENVWRAPPER_VIRTUALENV_ARGS:
-
-.. _variable-VIRTUALENVWRAPPER_PYTHON:
-
-Python Interpreter, virtualenv, and $PATH
------------------------------------------
-
-During startup, ``virtualenvwrapper.sh`` finds the first ``python``
-and ``virtualenv`` programs on the ``$PATH`` and remembers them to use
-later.  This eliminates any conflict as the ``$PATH`` changes,
-enabling interpreters inside virtual environments where
-virtualenvwrapper is not installed or where different versions of
-virtualenv are installed.  Because of this behavior, it is important
-for the ``$PATH`` to be set **before** sourcing
-``virtualenvwrapper.sh``.  For example::
-
-    export PATH=/usr/local/bin:$PATH
-    source /usr/local/bin/virtualenvwrapper.sh
-
-To override the ``$PATH`` search, set the variable
-``VIRTUALENVWRAPPER_PYTHON`` to the full path of the interpreter to
-use and ``VIRTUALENVWRAPPER_VIRTUALENV`` to the full path of the
-``virtualenv`` binary to use. Both variables *must* be set before
-sourcing ``virtualenvwrapper.sh``.  For example::
-
-    export VIRTUALENVWRAPPER_PYTHON=/usr/local/bin/python
-    export VIRTUALENVWRAPPER_VIRTUALENV=/usr/local/bin/virtualenv
-    source /usr/local/bin/virtualenvwrapper.sh
-
-Default Arguments for virtualenv
---------------------------------
-
-If the application identified by ``VIRTUALENVWRAPPER_VIRTUALENV``
-needs arguments, they can be set in
-``VIRTUALENVWRAPPER_VIRTUALENV_ARGS``. The same variable can be used
-to set default arguments to be passed to ``virtualenv``. For example,
-set the value to ``--no-site-packages`` to ensure that all new
-environments are isolated from the system ``site-packages`` directory.
-
-::
-
-    export VIRTUALENVWRAPPER_VIRTUALENV_ARGS='--no-site-packages'
-
-Temporary Files
----------------
-
-virtualenvwrapper creates temporary files in ``$TMPDIR``.  If the
-variable is not set, it uses ``/tmp``.  To change the location of
-temporary files just for virtualenvwrapper, set
-``VIRTUALENVWRAPPER_TMPDIR``.
-
-Site-wide Configuration
------------------------
-
-Most UNIX systems include the ability to change the configuration for
-all users. This typically takes one of two forms: editing the
-*skeleton* files for new accounts or editing the global startup file
-for a shell.
-
-Editing the skeleton files for new accounts means that each new user
-will have their private startup files preconfigured to load
-virtualenvwrapper. They can disable it by commenting out or removing
-those lines. Refer to the documentation for the shell and operating
-system to identify the appropriate file to edit.
-
-Modifying the global startup file for a given shell means that all
-users of that shell will have virtualenvwrapper enabled, and they
-cannot disable it. Refer to the documentation for the shell to
-identify the appropriate file to edit.
-
-Upgrading to 2.9
-================
-
-Version 2.9 includes the features previously delivered separately by
-``virtualenvwrapper.project``.  If you have an older verison of the
-project extensions installed, remove them before upgrading.
-
-Upgrading from 1.x
-==================
-
-The shell script containing the wrapper functions has been renamed in
-the 2.x series to reflect the fact that shells other than bash are
-supported.  In your startup file, change ``source
-/usr/local/bin/virtualenvwrapper_bashrc`` to ``source
-/usr/local/bin/virtualenvwrapper.sh``.
-
-.. _pip: http://pypi.python.org/pypi/pip

File docs/en/plugins.rst

-.. _plugins:
-
-===========================
-Extending Virtualenvwrapper
-===========================
-
-Long experience with home-grown solutions for customizing a
-development environment has proven how valuable it can be to have the
-ability to automate common tasks and eliminate persistent annoyances.
-Carpenters build jigs, software developers write shell scripts.
-virtualenvwrapper continues the tradition of encouraging a craftsman
-to modify their tools to work the way they want, rather than the other
-way around.
-