github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Provide specific links to virtualenvwrapper docs

Browse source 
Rather than detail how to install and configure virtualenvwrapper, it
seems best to instead link to the appropriate external docs.
This commit is contained in:
Justin Mayer 2012-08-06 06:11:54 -07:00
commit a3e24949af
1 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

32
docs/getting_started.rst
View file

@ -14,17 +14,15 @@ If you don't have ``pip`` installed, an alternative method is ``easy_install``::
$ easy_install pelican $ easy_install pelican
While the above is the simplest method, the recommended approach is to create While the above is the simplest method, the recommended approach is to create
a virtual environment for Pelican via `virtualenv <http://www.virtualenv.org/>`_ a virtual environment for Pelican via virtualenv_ and virtualenvwrapper_ before
and `virtualenvwrapper <http://www.doughellmann.com/projects/virtualenvwrapper/>`_ installing Pelican. Assuming you've followed the virtualenvwrapper
before installing Pelican:: `installation <http://virtualenvwrapper.readthedocs.org/en/latest/install.html>`_
and `shell configuration
$ sudo pip install --upgrade virtualenv virtualenvwrapper <http://virtualenvwrapper.readthedocs.org/en/latest/install.html#shell-startup-file>`_
steps, you can then open a new terminal session and create a new virtual
Note that virtualenvwrapper, being a shell hack, usually requires that a new shell environment for Pelican::
be started in order to be sourced. Continue -perhaps in a new shell::
$ mkvirtualenv pelican $ mkvirtualenv pelican
$ pip install pelican
Once the virtual environment has been created and activated, Pelican can be Once the virtual environment has been created and activated, Pelican can be
be installed via ``pip`` or ``easy_install`` as noted above. Alternatively, if be installed via ``pip`` or ``easy_install`` as noted above. Alternatively, if
@ -47,9 +45,9 @@ Markdown library as well::
Upgrading Upgrading
--------- ---------
If you installed a stable Pelican release via pip or easy_install and wish to If you installed a stable Pelican release via ``pip`` or ``easy_install`` and
upgrade to the latest stable release, you can do so by adding ``--upgrade`` to wish to upgrade to the latest stable release, you can do so by adding
the relevant command. For pip, that would be:: ``--upgrade`` to the relevant command. For pip, that would be::
$ pip install --upgrade pelican $ pip install --upgrade pelican
@ -76,11 +74,11 @@ Kickstart a blog
================ ================
Following is a brief tutorial for those who want to get started right away. Following is a brief tutorial for those who want to get started right away.
We're going to assume Pelican was installed in a virtual environment via the We're going to assume that virtualenv_ and virtualenvwrapper_ are installed and
following steps (if you're not using a virtual environment for Pelican, you can configured; if you've installed Pelican outside of a virtual environment,
skip to the ``pelican-quickstart`` command):: you can skip to the ``pelican-quickstart`` command. Let's first create a new
virtual environment and install Pelican into it::
$ sudo pip install --upgrade virtualenv virtualenvwrapper
$ mkvirtualenv pelican $ mkvirtualenv pelican
$ pip install pelican Markdown $ pip install pelican Markdown
@ -309,3 +307,5 @@ Or run a simple web server using Python::
cd output && python -m SimpleHTTPServer cd output && python -m SimpleHTTPServer
.. _virtualenv: http://www.virtualenv.org/
.. _virtualenvwrapper: http://www.doughellmann.com/projects/virtualenvwrapper/