[py-svn] pytest commit 3b14dfd0a106: improve docs

[commits-noreply at bitbucket.org]

# HG changeset patch -- Bitbucket.org
# Project pytest
# URL http://bitbucket.org/hpk42/pytest/overview
# User holger krekel <holger at merlinux.eu>
# Date 1290554602 -3600
# Node ID 3b14dfd0a106c184022acc1e8cda36c42ae9ec61
# Parent  39967d4a7b5d6d4b85f3cec58cd2f831dcaa4192
improve docs

--- a/doc/faq.txt
+++ b/doc/faq.txt
@@ -16,9 +16,10 @@ Some historic, some practical reasons: `
 the ``py`` package which provided several developer utitilities,
 all starting with ``py.<TAB>``, providing nice TAB-completion. If
 you install ``pip install pycmd`` you get these tools from a separate
-package.  These days the command line tool could be ``pytest``
-but then many people have gotten used to the old name and there
-also is another tool with this same which would lead to some clashes.
+package.  These days the command line tool could be called ``pytest``
+but then again many people have gotten used to the old name and there
+is another tool named "pytest" so we just decided to stick with
+``py.test``.
 
 What's py.test's relation to ``nosetests``?
 +++++++++++++++++++++++++++++++++++++++++++++++++
@@ -35,11 +36,12 @@ cycle.
 What's this "magic" with py.test?
 ++++++++++++++++++++++++++++++++++++++++++
 
-Around 2007 (version ``0.8``) some several people claimed that py.test
-was using too much "magic".  It has been refactored a lot.  It is today
+Around 2007 (version ``0.8``) some people claimed that py.test
+was using too much "magic".  It has been refactored a lot.  Thrown
+out old code.  Deprecated unused approaches and code.  And it is today
 probably one of the smallest, most universally runnable and most
-customizable testing frameworks for Python.   It remains true
-that ``py.test`` uses metaprogramming techniques, i.e. it views
+customizable testing frameworks for Python.   It's true that
+``py.test`` uses metaprogramming techniques, i.e. it views
 test code similar to how compilers view programs, using a
 somewhat abstract internal model.
 

--- a/doc/_static/sphinxdoc.css
+++ b/doc/_static/sphinxdoc.css
@@ -17,7 +17,7 @@
 body {
     font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
                  'Verdana', sans-serif;
-    font-size: 14px;
+    font-size: 1.1em;
     letter-spacing: -0.01em;
     line-height: 150%;
     text-align: center;
@@ -38,7 +38,7 @@ div.document {
 }
 
 div.bodywrapper {
-    margin: 0 360px 0 0;
+    margin: 0 240px 0 0;
     border-right: 1px solid #ccc;
 }
 
@@ -88,7 +88,7 @@ div.sphinxsidebarwrapper {
 div.sphinxsidebar {
     margin: 0;
     padding: 0.5em 15px 15px 0;
-    width: 310px;
+    width: 210px;
     float: right;
     font-size: 1em;
     text-align: left;
@@ -99,7 +99,7 @@ div.sphinxsidebar h3, div.sphinxsidebar 
     font-size: 1em;
     padding: 0.1em 0 0.1em 0.5em;
     color: white;
-    border: 2px solid #86989B;
+    border: 1px solid #86989B;
     background-color: #AFC1C4;
 }
 

--- /dev/null
+++ b/doc/_templates/layout.html
@@ -0,0 +1,41 @@
+{% extends "!layout.html" %}
+
+{% block relbar1 %}
+{% endblock %}
+{% block relbar2 %}
+{% endblock %}
+
+{% block rootrellink %}
+{% endblock %}
+{% block sidebarrel %}
+{% endblock %}
+
+{% block header %}
+<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
+    <h1>tox: virtualenv-based automation of test activities</h1>
+    <div style="text-align: left; font-size: 130%; vertical-align: middle;">
+            <a href="{{ pathto('index') }}">home</a> | 
+            <a href="{{ pathto('getting-started') }}">install</a> | 
+            <a href="{{ pathto('example/index') }}">examples</a> | 
+            <a href="{{ pathto('customize') }}">customize</a> | 
+            <a href="{{ pathto('contact') }}">contact</a> 
+    </div>
+</div>
+{% endblock %}
+
+{% block footer %}
+{{ super() }}
+<script type="text/javascript">
+
+  var _gaq = _gaq || [];
+  _gaq.push(['_setAccount', 'UA-7597274-13']);
+  _gaq.push(['_trackPageview']);
+
+  (function() {
+    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+  })();
+
+</script>
+{% endblock %}

--- a/doc/conf.py
+++ b/doc/conf.py
@@ -135,6 +135,7 @@ html_static_path = ['_static']
 
 # Custom sidebar templates, maps document names to template names.
 #html_sidebars = {}
+html_sidebars = {'index': 'indexsidebar.html'}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.

--- /dev/null
+++ b/doc/_templates/indexsidebar.html
@@ -0,0 +1,21 @@
+<h3>Download</h3>
+{% if version.endswith('(hg)') %}
+<p>This documentation is for version <b>{{ version }}</b>, which is
+  not released yet.</p>
+<p>You can use it from the
+  <a href="http://bitbucket.org/hpk42/pytest">Bitbucket Repo</a> or look for
+  released versions in the <a href="http://pypi.python.org/pypi/pytest">Python
+    Package Index</a>.</p>
+{% else %}
+<p>Current: <b>{{ version }}</b>
+[<a href="{{ pathto('changelog') }}">Changes</a>]</p>
+<p>
+<a href="http://pypi.python.org/pypi/pytest">pytest on PyPI</a>
+</p>
+<pre>pip install pytest</pre>
+{% endif %}
+
+<h3>Questions? Suggestions?</h3>
+
+<p>Checkout <a href="{{ pathto('contact') }}">support channels</a>
+</p>

--- a/doc/announce/release-2.0.0.txt
+++ b/doc/announce/release-2.0.0.txt
@@ -2,13 +2,18 @@ py.test 2.0.0: improved asserts, unittes
 ===========================================================================
 
 Welcome to pytest-2.0.0, a major new release of "py.test", the rapid
-easy Python testing tool.  There are many new features and a lot of
-long-deprecated code is removed, resulting in a much smaller and cleaner
-implementation.  If you had a test suite using non-deprecated
-functionality 2.0.0 is very likely to continue to work for you without
-requiring changes.
+easy Python testing tool.  There are many new features and enhancements,
+see below.  Also a lot of long-deprecated code has been removed,
+resulting in a much smaller and cleaner implementation.   Note that
+pytest used to part of the "py" distribution up until version py-1.3.4
+but this has changed now:  pytest-2.0.0 only contains py.test related
+code and is expected to be backward-compatible to existing test code. If
+you want to install it, type one of::
 
-Check out the revised the improved documentation and examples:
+    pip install -U pytest
+    easy_install -U pytest
+
+and check out the much improved documentation and examples:
 
     http://pytest.org/2.0.0/index.html
 
@@ -136,6 +141,7 @@ More Detailed Changes between 1.3.4 and 
   is removed).
 - add a new "-q" option which decreases verbosity and prints a more
   nose/unittest-style "dot" output.
+- fix issue135 - marks now work with unittest test cases as well
 - fix issue126 - introduce py.test.set_trace() to trace execution via
   PDB during the running of tests even if capturing is ongoing.
 - fix issue123 - new "python -m py.test" invocation for py.test
@@ -160,3 +166,6 @@ More Detailed Changes between 1.3.4 and 
 - fix issue93 stdout/stderr is captured while importing conftest.py
 - fix bug: unittest collected functions now also can have "pytestmark"
   applied at class/module level
+- add ability to use "class" level for cached_setup helper
+- fix strangeness: mark.* objects are now immutable, create new instances
+