From 6ebd5f29004849907374391db43daf23b6c31fc6 Mon Sep 17 00:00:00 2001 From: holger krekel Date: Wed, 24 Nov 2010 00:23:22 +0100 Subject: [PATCH] improve docs --- doc/_static/sphinxdoc.css | 8 +++---- doc/_templates/indexsidebar.html | 21 ++++++++++++++++ doc/_templates/layout.html | 41 ++++++++++++++++++++++++++++++++ doc/announce/release-2.0.0.txt | 21 +++++++++++----- doc/conf.py | 1 + doc/faq.txt | 16 +++++++------ 6 files changed, 91 insertions(+), 17 deletions(-) create mode 100644 doc/_templates/indexsidebar.html create mode 100644 doc/_templates/layout.html diff --git a/doc/_static/sphinxdoc.css b/doc/_static/sphinxdoc.css index 780f7ba74..02b940b0c 100644 --- 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 h4 { font-size: 1em; padding: 0.1em 0 0.1em 0.5em; color: white; - border: 2px solid #86989B; + border: 1px solid #86989B; background-color: #AFC1C4; } diff --git a/doc/_templates/indexsidebar.html b/doc/_templates/indexsidebar.html new file mode 100644 index 000000000..28ab8fcdb --- /dev/null +++ b/doc/_templates/indexsidebar.html @@ -0,0 +1,21 @@ +

Download

+{% if version.endswith('(hg)') %} +

This documentation is for version {{ version }}, which is + not released yet.

+

You can use it from the + Bitbucket Repo or look for + released versions in the Python + Package Index.

+{% else %} +

Current: {{ version }} +[Changes]

+

+pytest on PyPI +

+
pip install pytest
+{% endif %} + +

Questions? Suggestions?

+ +

Checkout support channels +

diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html new file mode 100644 index 000000000..4b8adadf7 --- /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 %} +
+

tox: virtualenv-based automation of test activities

+
+ home |  + install |  + examples |  + customize |  + contact  +
+
+{% endblock %} + +{% block footer %} +{{ super() }} + +{% endblock %} diff --git a/doc/announce/release-2.0.0.txt b/doc/announce/release-2.0.0.txt index 6cbc50797..4c2fd48d4 100644 --- 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, unittest, reporting, config, docs =========================================================================== 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 2.0.0 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 2.0.0 - 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 + diff --git a/doc/conf.py b/doc/conf.py index e93fa4e8c..c01da745f 100644 --- 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. diff --git a/doc/faq.txt b/doc/faq.txt index 6cae8a844..95a082a7c 100644 --- a/doc/faq.txt +++ b/doc/faq.txt @@ -16,9 +16,10 @@ Some historic, some practical reasons: ``py.test`` used to be part of the ``py`` package which provided several developer utitilities, all starting with ``py.``, 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.