reshuffle start page as per gutworth feedback

doc/_templates/localtoc.html

@@ -16,9 +16,9 @@
 <table>
 <tr>
 <td>
-        <a href="{{ pathto('index') }}">index</a>
+        <a href="{{ pathto('index') }}">home</a>
 </td><td>
-        <a href="{{ pathto('features') }}">features</a>
+        <a href="{{ pathto('contents') }}">contents</a>
 </td></tr><tr><td>
         <a href="{{ pathto('getting-started') }}">install</a>
 </td><td>

doc/conf.py

@@ -38,7 +38,7 @@ source_suffix = '.txt'
 #source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = 'contents'
 
 # General information about the project.
 project = u'pytest'
@@ -135,7 +135,7 @@ html_static_path = ['_static']
 
 # Custom sidebar templates, maps document names to template names.
 #html_sidebars = {}
-#html_sidebars = {'*': 'sidebar.html'}
+#html_sidebars = {'index': 'indexsidebar.html'}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.

doc/contents.txt

@@ -0,0 +1,24 @@
+
+.. _toc:
+
+Table of Contents
+========================
+
+.. toctree::
+   :maxdepth: 2
+
+   overview
+   example/index
+   apiref
+   plugins
+   talks
+   develop
+   announce/index
+
+.. toctree::
+   :hidden:
+
+   changelog.txt
+   naming20.txt
+   example/attic
+

doc/features.txt

@@ -1,57 +0,0 @@
-
-
-Feature Overview
-=============================================
-
-
-- **a mature full-featured testing tool**
-
- - runs on Posix/Windows, Python 2.4-3.2, PyPy and Jython
- - continuously `tested on many Python interpreters <http://hudson.testrun.org/view/pytest/job/pytest/>`_
- - used in :ref:`many projects and organisations <projects>`, in test
-   suites ranging from 10 to 10s of thousands of tests
- - has :ref:`comprehensive documentation <toc>`
- - comes with :ref:`tested examples <examples>`
- - supports :ref:`good integration practises <goodpractises>`
-
-- **provides no-boilerplate testing**
-
- - makes it :ref:`easy to get started <getstarted>`,
- - refined :ref:`usage options <usage>`
- - :ref:`assert with the assert statement`
- - helpful :ref:`traceback and failing assertion reporting <tbreportdemo>`
- - allows :ref:`print debugging <printdebugging>` and :ref:`the
-   capturing of standard output during test execution <captures>`
- - supports :pep:`8` compliant coding styles in tests
-
-- **supports functional testing and complex test setups**
-
- - advanced :ref:`skip and xfail`
- - generic :ref:`marking and test selection <mark>`
- - can :ref:`distribute tests to multiple CPUs <xdistcpu>` through :ref:`xdist plugin <xdist>`
- - can :ref:`continuously re-run failing tests <looponfailing>`
- - many :ref:`builtin helpers <pytest helpers>`
- - flexible :ref:`Python test discovery`
- - unique :ref:`dependency injection through funcargs <funcargs>`
- - :ref:`parametrized test functions <parametrized test functions>`
-
-- **integrates many common testing methods**
-
- - can integrate ``nose``, ``unittest.py`` and ``doctest.py`` style
-   tests, including running testcases made for Django and trial
- - supports extended :ref:`xUnit style setup <xunitsetup>`
- - supports domain-specific :ref:`non-python tests`
- - supports the generation of testing coverage reports
- - `Javascript unit- and functional testing`_
-
-- **extensive plugin and customization system**
-
- - all collection, reporting, running aspects are delegated to hook functions
- - customizations can be per-directory, per-project or per PyPI released plugins
- - it is easy to add command line options or do other kind of add-ons and customizations.
-
-.. _`Javascript unit- and functional testing`: http://pypi.python.org/pypi/oejskit
-
-.. _`easy`: http://bruynooghe.blogspot.com/2009/12/skipping-slow-test-by-default-in-pytest.html
-
-

doc/index.txt

@@ -1,24 +1,56 @@
 
-.. _toc:
 
-Table of Contents
+Welcome to pytest / features
-========================
+=============================================
 
-.. toctree::
+- **a mature full-featured testing tool**
-   :maxdepth: 2
 
-   overview
+ - runs on Posix/Windows, Python 2.4-3.2, PyPy and Jython
-   example/index
+ - continuously `tested on many Python interpreters <http://hudson.testrun.org/view/pytest/job/pytest/>`_
-   apiref
+ - used in :ref:`many projects and organisations <projects>`, in test
-   plugins
+   suites ranging from 10 to 10s of thousands of tests
-   talks
+ - has :ref:`comprehensive documentation <toc>`
-   develop
+ - comes with :ref:`tested examples <examples>`
-   announce/index
+ - supports :ref:`good integration practises <goodpractises>`
 
-.. toctree::
+- **provides no-boilerplate testing**
-   :hidden:
+
+ - makes it :ref:`easy to get started <getstarted>`,
+ - refined :ref:`usage options <usage>`
+ - :ref:`assert with the assert statement`
+ - helpful :ref:`traceback and failing assertion reporting <tbreportdemo>`
+ - allows :ref:`print debugging <printdebugging>` and :ref:`the
+   capturing of standard output during test execution <captures>`
+ - supports :pep:`8` compliant coding styles in tests
+
+- **supports functional testing and complex test setups**
+
+ - advanced :ref:`skip and xfail`
+ - generic :ref:`marking and test selection <mark>`
+ - can :ref:`distribute tests to multiple CPUs <xdistcpu>` through :ref:`xdist plugin <xdist>`
+ - can :ref:`continuously re-run failing tests <looponfailing>`
+ - many :ref:`builtin helpers <pytest helpers>`
+ - flexible :ref:`Python test discovery`
+ - unique :ref:`dependency injection through funcargs <funcargs>`
+ - :ref:`parametrized test functions <parametrized test functions>`
+
+- **integrates many common testing methods**
+
+ - can integrate ``nose``, ``unittest.py`` and ``doctest.py`` style
+   tests, including running testcases made for Django and trial
+ - supports extended :ref:`xUnit style setup <xunitsetup>`
+ - supports domain-specific :ref:`non-python tests`
+ - supports the generation of testing coverage reports
+ - `Javascript unit- and functional testing`_
+
+- **extensive plugin and customization system**
+
+ - all collection, reporting, running aspects are delegated to hook functions
+ - customizations can be per-directory, per-project or per PyPI released plugins
+ - it is easy to add command line options or do other kind of add-ons and customizations.
+
+.. _`Javascript unit- and functional testing`: http://pypi.python.org/pypi/oejskit
+
+.. _`easy`: http://bruynooghe.blogspot.com/2009/12/skipping-slow-test-by-default-in-pytest.html
 
-   changelog.txt
-   naming20.txt
-   example/attic
 

doc/overview.txt

@@ -5,7 +5,7 @@ Getting started basics
 .. toctree::
    :maxdepth: 2
 
-   features.txt
+   index.txt
    getting-started.txt
    usage.txt
    goodpractises.txt