Merge branch 'master' of github.com:Pylons/pyramid

4 files changed, 53 insertions, 3 deletions

diff --git a/HACKING.txt b/HACKING.txt
index 5b5dcc458..5d33aa0ab 100644
--- a/HACKING.txt
+++ b/HACKING.txt
@@ -16,13 +16,31 @@ checkout.
 
 - Check out a read-only copy of the Pyramid source::
 
-  $ git clone git://github.com/Pylons/pyramid.git
+  $ git clone git://github.com/Pylons/pyramid.git .
 
   (alternately, create a writeable fork on GitHub and check that out).
 
+Since pyramid is a framework and not an application, it can be
+convenient to work against a sample application, preferably in its
+own virtualenv. A quick way to achieve this is to (ab-)use ``tox``
+with a custom configuration file that's part of the checkout::
+
+  tox -c hacking-tox.ini
+
+This will create a python-2.7 based virtualenv named ``env27`` (pyramid's
+``.gitconfig` ignores all top-level folders that start with ``env`` specifically
+for this use case) and inside that a simple pyramid application named
+``hacking`` that you can then fire up like so::
+
+  cd env27/hacking
+  ../bin/pserve development.ini
+
+Alternatively, if you don't want to install ``tox`` at this point,
+you an achieve the same manually by following these steps:
+
 - Create a virtualenv in which to install Pyramid::
 
-  $ virtualenv2.6 --no-site-packages env
+  $ virtualenv env
 
 - Install ``setuptools-git`` into the virtualenv (for good measure, as we're
   using git to do version control)::
@@ -110,6 +128,13 @@ Running Tests
    $ cd ~/hack-on-pyramid/pyramid
    $ /usr/bin/tox
 
+- The tests can also be run usign ``pytest`` (http://pytest.org/).  This is
+  intended as a convenience for people who are more used or fond of ``pytest``.
+  Run the tests like so::
+
+   $ $VENV/bin/easy_install pytest
+   $ py.test --strict pyramid/
+
 Test Coverage
 -------------
 
diff --git a/docs/_themes b/docs/_themes
-Subproject 8673c4a14f192c15f1949dc9862821e60f31604
+Subproject a181b85d4ca08fa109ee2786d4f1b5b17e9b458
diff --git a/docs/conf.py b/docs/conf.py
index 4c6ed76ad..3a8076cdf 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -403,7 +403,7 @@ latex_elements = {
     'wrapperclass': 'book',
     'date': '',
     'releasename': 'Version',
-    'title': r'The Pyramid Web Application \newline Development Framework',
+    'title': r'The Pyramid Web Framework',
 #    'pointsize':'12pt', # uncomment for 12pt version
 }
 
diff --git a/hacking-tox.ini b/hacking-tox.ini
new file mode 100644
index 000000000..9520b7aef
--- /dev/null
+++ b/hacking-tox.ini
@@ -0,0 +1,25 @@
+[tox]
+envlist = 
+    env27,ttw27-create,ttw27-install
+
+[testenv:env27]
+envdir = env27
+basepython = python2.7
+usedevelop = True
+deps = setuptools-git
+commands =
+    python setup.py dev
+
+[testenv:ttw27-create]
+envdir = env27
+usedevelop = True
+changedir = env27
+commands =
+    pcreate -s starter hacking
+
+[testenv:ttw27-install]
+envdir = env27
+usedevelop = True
+changedir = env27/hacking
+commands =
+    python setup.py develop