Make virtualenvs conform to the style guide a bit more. Plus some additional changes

john2x · john2x · commit 7e3b364d0ff7 · 2012-01-05T15:06:24.000+08:00
diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst
@@ -14,29 +14,37 @@ virtualenv
 `virtualenv <http://pypi.python.org/pypi/virtualenv>`_ is a tool to create 
 isolated Python environments.
 
-Install it via pip::
+Install it via pip:
+
+.. code-block:: console
 
   $ pip install virtualenv
 
 Basic Usage
 ~~~~~~~~~~~
 
-1. Create a virtual environment::
+1. Create a virtual environment:
+
+.. code-block:: console
 
-   $ virtualenv ENVIRONMENT_NAME
+   $ virtualenv venv
 
 This creates a copy of Python in whichever directory you ran the command in, 
-placing it in a folder named ``ENVIRONMENT_NAME``.
+placing it in a folder named ``venv``.
+
+2. To begin using the virtual environment, it needs to be activated:
 
-2. To begin using the virtual environment, it needs to be activated::
+.. code-block:: console
 
-   $ source ENVIRONMENT_NAME/bin/activate
+   $ source venv/bin/activate
 
 You can then begin installing any new modules without affecting the system 
 default Python or other virtual environments.
 
 3. If you are done working in the virtual environment for the moment, you can 
-   deactivate it::
+   deactivate it:
+
+.. code-block:: console
 
    $ deactivate
 
@@ -45,49 +53,64 @@ installed libraries.
 
 To delete a virtual environment, just delete its folder.
 
+After a while, though, you might end up with a lot of virtual environments 
+littered across your system, and its possible you'll forget their names or 
+where they were placed. 
+
 virtualenvwrapper
 -----------------
 
 `virtualenvwrapper <http://www.doughellmann.com/projects/virtualenvwrapper/>`_ 
 provides a set of commands which makes working with virtual environments much 
-more pleasant. It also places all your virtual environments into one place.
+more pleasant. It also places all your virtual environments in one place.
 
-To install (make sure **virtualenv** is already installed)::
+To install (make sure **virtualenv** is already installed):
+
+.. code-block:: console
 
   $ pip install virtualenvwrapper
   $ export WORKON_HOME=~/Envs
   $ source /usr/local/bin/virtualenvwrapper.sh
 
-(Full instructions `here <http://www.doughellmann.com/docs/virtualenvwrapper/#introduction>`_.)
+(`Full virtualenvwrapper install instructions <http://www.doughellmann.com/docs/virtualenvwrapper/#introduction>`_.)
 
 Basic Usage
 ~~~~~~~~~~~
 
-1. Create a virtual environment::
+1. Create a virtual environment:
+
+.. code-block:: console
+
+   $ mkvirtualenv venv
 
-   $ mkvirtualenv ENVIRONMENT_NAME
+This creates the ``venv`` folder inside ``~/Envs``. 
 
-This creates the ``ENVIRONMENT_NAME`` folder inside ``~/Envs``. 
+2. Work on a virtual environment:
 
-2. Work on a virtual environment::
+.. code-block:: console
 
-   $ workon ENVIRONMENT_NAME
+   $ workon venv
 
 **virtualenvwrapper** provides tab-completion on environment names. It really 
 helps when you have a lot of environments and have trouble remembering their 
 names. 
 ``workon`` also deactivates whatever environment you are currently in, so you 
 can quickly switch between environments.
 
-3. Deactivating is still the same::
+3. Deactivating is still the same:
+
+.. code-block:: console
 
    $ deactivate
 
-4. To delete::
+4. To delete:
+
+.. code-block:: console
 
-   $ rmvirtualenv ENVIRONMENT_NAME
+   $ rmvirtualenv venv
 
-Other nifty commands include:
+Other useful commands
+~~~~~~~~~~~~~~~~~~~~~
 
 ``lsvirtualenv``
   List all of the environments.
@@ -102,4 +125,4 @@ Other nifty commands include:
 ``lssitepackages``
   Shows contents of ``site-packages`` directory.
 
-A full list of commands can be found `here <http://www.doughellmann.com/docs/virtualenvwrapper/command_ref.html#managing-environments>`_.
+`Full list of virtualenvwrapper commands <http://www.doughellmann.com/docs/virtualenvwrapper/command_ref.html#managing-environments>`_.
