summaryrefslogtreecommitdiff
path: root/docs/narr/project.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2013-03-18 16:01:43 -0700
committerChris McDonough <chrism@plope.com>2013-03-18 16:01:43 -0700
commit881feb9c25b5c16d05e5ae9f3384eded1231fe59 (patch)
tree812ba136637b4b46655455b2a357d638ef505f10 /docs/narr/project.rst
parentc7a06f41d56d076dc979d800388c8befc1b8e5e5 (diff)
parentfc9dfbae2a76732ee8d027825fac28dbfd57e581 (diff)
downloadpyramid-881feb9c25b5c16d05e5ae9f3384eded1231fe59.tar.gz
pyramid-881feb9c25b5c16d05e5ae9f3384eded1231fe59.tar.bz2
pyramid-881feb9c25b5c16d05e5ae9f3384eded1231fe59.zip
Merge branch 'master' of github.com:Pylons/pyramid
Diffstat (limited to 'docs/narr/project.rst')
-rw-r--r--docs/narr/project.rst53
1 files changed, 22 insertions, 31 deletions
diff --git a/docs/narr/project.rst b/docs/narr/project.rst
index 5a8ea0ecf..a168c24eb 100644
--- a/docs/narr/project.rst
+++ b/docs/narr/project.rst
@@ -80,13 +80,13 @@ On UNIX:
.. code-block:: text
- $ bin/pcreate -s starter MyProject
+ $ $VENV/bin/pcreate -s starter MyProject
Or on Windows:
.. code-block:: text
- > Scripts\pcreate -s starter MyProject
+ > %VENV%\Scripts\pcreate -s starter MyProject
The above command uses the ``pcreate`` command to create a project with the
``starter`` scaffold. To use a different scaffold, such as
@@ -95,20 +95,20 @@ on UNIX:
.. code-block:: text
- $ bin/pcreate -s alchemy MyProject
+ $ $VENV/bin/pcreate -s alchemy MyProject
Or on Windows:
.. code-block:: text
- > Scripts\pcreate -s alchemy MyProject
+ > %VENV%\Scripts\pcreate -s alchemy MyProject
Here's sample output from a run of ``pcreate`` on UNIX for a project we name
``MyProject``:
.. code-block:: text
- $ bin/pcreate -s starter MyProject
+ $ $VENV/bin/pcreate -s starter MyProject
Creating template pyramid
Creating directory ./MyProject
# ... more output ...
@@ -177,21 +177,21 @@ On UNIX:
.. code-block:: text
$ cd MyProject
- $ ../bin/python setup.py develop
+ $ $VENV/bin/python setup.py develop
Or on Windows:
.. code-block:: text
> cd MyProject
- > ..\Scripts\python.exe setup.py develop
+ > %VENV%\Scripts\python.exe setup.py develop
Elided output from a run of this command on UNIX is shown below:
.. code-block:: text
$ cd MyProject
- $ ../bin/python setup.py develop
+ $ $VENV/bin/python setup.py develop
...
Finished processing dependencies for MyProject==0.0
@@ -216,19 +216,19 @@ On UNIX:
.. code-block:: text
- $ ../bin/python setup.py test -q
+ $ $VENV/bin/python setup.py test -q
Or on Windows:
.. code-block:: text
- > ..\Scripts\python.exe setup.py test -q
+ > %VENV%\Scripts\python.exe setup.py test -q
Here's sample output from a test run on UNIX:
.. code-block:: text
- $ ../bin/python setup.py test -q
+ $ $VENV/bin/python setup.py test -q
running test
running egg_info
writing requirements to MyProject.egg-info/requires.txt
@@ -272,19 +272,19 @@ On UNIX:
.. code-block:: text
- $ ../bin/pserve development.ini
+ $ $VENV/bin/pserve development.ini
On Windows:
.. code-block:: text
- > ..\Scripts\pserve development.ini
+ > %VENV%\Scripts\pserve development.ini
Here's sample output from a run of ``pserve`` on UNIX:
.. code-block:: text
- $ ../bin/pserve development.ini
+ $ $VENV/bin/pserve development.ini
Starting server in PID 16601.
serving on http://0.0.0.0:6543
@@ -305,7 +305,9 @@ If you want to restrict access such that only a browser running on the same
machine as Pyramid will be able to access your Pyramid application, edit the
``development.ini`` file, and replace the ``host`` value in the
``[server:main]`` section. Change it from ``0.0.0.0`` to ``127.0.0.1``. For
-example::
+example:
+
+.. code-block:: ini
[server:main]
use = egg:waitress#main
@@ -357,7 +359,7 @@ For example, on UNIX:
.. code-block:: text
- $ ../bin/pserve development.ini --reload
+ $ $VENV/bin/pserve development.ini --reload
Starting subprocess with file monitor
Starting server in PID 16601.
serving on http://0.0.0.0:6543
@@ -459,20 +461,9 @@ Put a hash mark at the beginning of the ``pyramid_debugtoolbar`` line:
Then restart the application to see that the toolbar has been turned off.
Note that if you comment out the ``pyramid_debugtoolbar`` line, the ``#``
-*must* be in the first column. If you put the hash mark anywhere except the
-first column instead, for example like this:
-
-.. code-block:: ini
- :linenos:
-
- [app:main]
- ...
- pyramid.includes =
- #pyramid_debugtoolbar
-
-When you attempt to restart the application with a section like the above
-you'll receive an error that ends something like this, and the application
-will not start:
+*must* be in the first column. If you put it anywhere else,
+and then attempt to restart the application,
+you'll receive an error that ends something like this:
.. code-block:: text
@@ -703,7 +694,7 @@ work properly.
The ``setup.py`` file is a :term:`setuptools` setup file. It is meant to be
run directly from the command line to perform a variety of functions, such as
-testing your application, packaging, and distributing your application.
+testing, packaging, and distributing your application.
.. note::