install
|
diff --git a/doc/conf.py b/doc/conf.py
index 97feface3..dcf14f03c 100644
--- a/doc/conf.py
+++ b/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.
diff --git a/doc/contents.txt b/doc/contents.txt
new file mode 100644
index 000000000..dc09b8e9c
--- /dev/null
+++ b/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
+
diff --git a/doc/features.txt b/doc/features.txt
deleted file mode 100644
index 6f6aba490..000000000
--- a/doc/features.txt
+++ /dev/null
@@ -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 `_
- - used in :ref:`many projects and organisations `, in test
- suites ranging from 10 to 10s of thousands of tests
- - has :ref:`comprehensive documentation `
- - comes with :ref:`tested examples `
- - supports :ref:`good integration practises `
-
-- **provides no-boilerplate testing**
-
- - makes it :ref:`easy to get started `,
- - refined :ref:`usage options `
- - :ref:`assert with the assert statement`
- - helpful :ref:`traceback and failing assertion reporting `
- - allows :ref:`print debugging ` and :ref:`the
- capturing of standard output during test execution `
- - 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 `
- - can :ref:`distribute tests to multiple CPUs ` through :ref:`xdist plugin `
- - can :ref:`continuously re-run failing tests `
- - many :ref:`builtin helpers `
- - flexible :ref:`Python test discovery`
- - unique :ref:`dependency injection through funcargs `
- - :ref:`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 `
- - 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
-
-
diff --git a/doc/index.txt b/doc/index.txt
index dc09b8e9c..d9a52a44e 100644
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -1,24 +1,56 @@
-.. _toc:
-Table of Contents
-========================
+Welcome to pytest / features
+=============================================
-.. toctree::
- :maxdepth: 2
+- **a mature full-featured testing tool**
- overview
- example/index
- apiref
- plugins
- talks
- develop
- announce/index
+ - runs on Posix/Windows, Python 2.4-3.2, PyPy and Jython
+ - continuously `tested on many Python interpreters `_
+ - used in :ref:`many projects and organisations `, in test
+ suites ranging from 10 to 10s of thousands of tests
+ - has :ref:`comprehensive documentation `
+ - comes with :ref:`tested examples `
+ - supports :ref:`good integration practises `
-.. toctree::
- :hidden:
+- **provides no-boilerplate testing**
+
+ - makes it :ref:`easy to get started `,
+ - refined :ref:`usage options `
+ - :ref:`assert with the assert statement`
+ - helpful :ref:`traceback and failing assertion reporting `
+ - allows :ref:`print debugging ` and :ref:`the
+ capturing of standard output during test execution `
+ - 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 `
+ - can :ref:`distribute tests to multiple CPUs ` through :ref:`xdist plugin `
+ - can :ref:`continuously re-run failing tests `
+ - many :ref:`builtin helpers `
+ - flexible :ref:`Python test discovery`
+ - unique :ref:`dependency injection through funcargs `
+ - :ref:`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 `
+ - 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
diff --git a/doc/overview.txt b/doc/overview.txt
index ccdd40791..321d79d8c 100644
--- a/doc/overview.txt
+++ b/doc/overview.txt
@@ -5,7 +5,7 @@ Getting started basics
.. toctree::
:maxdepth: 2
- features.txt
+ index.txt
getting-started.txt
usage.txt
goodpractises.txt
|