summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2016-04-04 01:01:42 -0700
committerSteve Piercy <web@stevepiercy.com>2016-04-04 01:01:42 -0700
commitb9b31f0ca0dead8dd3835f26d6db6c53c8c7b72c (patch)
tree56efdcfb81166c298ff3da7471c22e3d65797f72 /docs
parent02b71071153b1e8e345392575eff45e584f2c88e (diff)
parent74c56e0e8d767ac0942cb17cde535113e97d8db1 (diff)
downloadpyramid-b9b31f0ca0dead8dd3835f26d6db6c53c8c7b72c.tar.gz
pyramid-b9b31f0ca0dead8dd3835f26d6db6c53c8c7b72c.tar.bz2
pyramid-b9b31f0ca0dead8dd3835f26d6db6c53c8c7b72c.zip
Merge pull request #2428 from stevepiercy/docs/easy-install-to-pip.2104
- replace setup.py with pip
Diffstat (limited to 'docs')
-rw-r--r--docs/quick_tutorial/hello_world.rst2
-rw-r--r--docs/quick_tutorial/scaffolds.rst11
-rw-r--r--docs/quick_tutorial/tutorial_approach.rst2
3 files changed, 8 insertions, 7 deletions
diff --git a/docs/quick_tutorial/hello_world.rst b/docs/quick_tutorial/hello_world.rst
index 4ae80ca87..fb661e9c5 100644
--- a/docs/quick_tutorial/hello_world.rst
+++ b/docs/quick_tutorial/hello_world.rst
@@ -5,7 +5,7 @@
================================
What's the simplest way to get started in Pyramid? A single-file module.
-No Python packages, no ``setup.py``, no other machinery.
+No Python packages, no ``pip install -e .``, no other machinery.
Background
==========
diff --git a/docs/quick_tutorial/scaffolds.rst b/docs/quick_tutorial/scaffolds.rst
index 4f2694100..319eb9d90 100644
--- a/docs/quick_tutorial/scaffolds.rst
+++ b/docs/quick_tutorial/scaffolds.rst
@@ -12,7 +12,7 @@ Background
==========
We're going to cover a lot in this tutorial, focusing on one topic at a
-time and writing everything from scratch. As a warmup, though,
+time and writing everything from scratch. As a warm up, though,
it sure would be nice to see some pixels on a screen.
Like other web development frameworks, Pyramid provides a number of
@@ -47,21 +47,22 @@ Steps
$ $VENV/bin/pcreate --scaffold starter scaffolds
-#. Use normal Python development to setup our project for development:
+#. Install our project in editable mode for development in the current
+ directory:
.. code-block:: bash
$ cd scaffolds
- $ $VENV/bin/python setup.py develop
+ $ $VENV/bin/pip install -e .
-#. Startup the application by pointing Pyramid's ``pserve`` command at
+#. Start up the application by pointing Pyramid's ``pserve`` command at
the project's (generated) configuration file:
.. code-block:: bash
$ $VENV/bin/pserve development.ini --reload
- On startup, ``pserve`` logs some output:
+ On start up, ``pserve`` logs some output:
.. code-block:: bash
diff --git a/docs/quick_tutorial/tutorial_approach.rst b/docs/quick_tutorial/tutorial_approach.rst
index 204d388b0..8298a4710 100644
--- a/docs/quick_tutorial/tutorial_approach.rst
+++ b/docs/quick_tutorial/tutorial_approach.rst
@@ -17,7 +17,7 @@ repo, where each step/topic/directory is a Python package.
To successfully run each step::
$ cd request_response
- $ $VENV/bin/python setup.py develop
+ $ $VENV/bin/pip install -e .
...and repeat for each step you would like to work on. In most cases we
will start with the results of an earlier step.