openstack/deb-python-eventlet
Code Issues Proposed changes

doc: recommend install via pip

Browse Source
This commit is contained in:
Omer Katz
2013-11-06 14:40:15 +02:00
committed by Sergey Shepelev
parent 625624b0a7
commit 256a1cf406
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.rst
View File

@@ -10,6 +10,7 @@ applications to use it. Start off by looking at the `examples`_,
.. _common design patterns: http://eventlet.net/doc/design_patterns.html .. _common design patterns: http://eventlet.net/doc/design_patterns.html
.. _basic API primitives: http://eventlet.net/doc/basic_usage.html .. _basic API primitives: http://eventlet.net/doc/basic_usage.html
Quick Example Quick Example
=============== ===============
@@ -27,24 +28,23 @@ Here's something you can try right on the command line::
Getting Eventlet Getting Eventlet
================== ==================
The easiest way to get Eventlet is to use easy_install or pip:: The easiest way to get Eventlet is to use pip::
easy_install eventlet
pip install eventlet pip install eventlet
The development `tip`_ is available via easy_install as well:: The development `tip`_ is available as well::
easy_install 'eventlet==dev'
pip install 'eventlet==dev' pip install 'eventlet==dev'
.. _tip: http://bitbucket.org/eventlet/eventlet/get/tip.zip#egg=eventlet-dev .. _tip: http://bitbucket.org/eventlet/eventlet/get/tip.zip#egg=eventlet-dev
Building the Docs Locally Building the Docs Locally
========================= =========================
To build a complete set of HTML documentation, you must have Sphinx, which can be found at http://sphinx.pocoo.org/ (or installed with `easy_install sphinx`) To build a complete set of HTML documentation, you must have Sphinx, which can be found at http://sphinx.pocoo.org/ (or installed with `pip install Sphinx`)::
cd doc cd doc
make html make html
The built html files can be found in doc/_build/html afterward. The built html files can be found in doc/_build/html afterward.