Merge branch 'doc'

Author: RKrahl

CHANGES

@@ -46,6 +46,10 @@
 
  + Issue #15: tests fail with pytest 3.3.0.
 
+ + Clarify in the documentation that Python 3.1 is not officially
+   supported because pytest 2.8 does not support it.  There is no
+   known issue with Python 3.1 though.
+
 * Version 0.2 (2017-05-28)
 
 ** New features

README.rst

@@ -20,11 +20,13 @@ The latest release version can be found at PyPI, see
 System requirements
 -------------------
 
-+ Python 2.6, 2.7, or 3.1 and newer.
++ Python 2.6, 2.7, or 3.2 and newer.
   Python 2.6 requires patching the sources, see below.
 + `setuptools`_.
 + `pytest`_ 2.8.0 or newer.
 
+(Python 3.1 is not supported by pytest 2.8.0 itself.)
+
 
 Installation
 ------------
@@ -70,16 +72,6 @@ The example test modules used in the documentation can be found in
 doc/examples in the source distribution.
 
 
-Bugs and limitations
---------------------
-
-+ The test fails with Python 3.1.  At first glance, this looks like a
-  problem between pytest and Python 3.1 rather then an issue in
-  pytest-dependency.  I didn't investigate this in detail, though.  In
-  any case, the module can be installed and the plugin seem to work
-  fine also with Python 3.1.
-
-
 Copyright and License
 ---------------------
 

doc/src/advanced.rst

@@ -17,11 +17,12 @@ Consider the following example test module:
 .. literalinclude:: ../examples/dyn-parametrized.py
 
 In principle, this example works the very same way as the basic
-example for parametrized tests, see :ref:`usage-parametrized`.  The
-only difference is that the lists of paramters are dynamically
-compiled beforehand.  The test for child `l` deliberately fails, just
-to show the effect.  As a consequence, the test for its parent `d`
-will be skipped.
+example for :ref:`usage-parametrized`.  The only difference is that
+the lists of paramters are dynamically compiled beforehand.  The test
+for child `l` deliberately fails, just to show the effect.  As a
+consequence, the test for its parent `d` will be skipped.
+
+.. _advanced-grouping-fixtures:
 
 Grouping tests using fixtures
 -----------------------------

doc/src/configuration.rst

@@ -0,0 +1,16 @@
+Configuring pytest-dependency
+=============================
+
+This section explains configuration options for pytest-dependency and
+also other configuration that is recommended for the use with
+pytest-dependency.
+
+Configuration file options
+--------------------------
+
+Configuration file options can be set in the `ini file`.
+
+   minversion
+      This is a builtin configuration of pytest itself.  Since
+      pytest-dependency requires pytest 2.8.0 or newer, it is
+      recommended to set this option accordingly.

doc/src/index.rst

@@ -15,4 +15,5 @@ Content of the documentation
    install
    usage
    advanced
+   configuration
    reference

doc/src/install.rst

@@ -4,11 +4,13 @@ Installation instructions
 System requirements
 -------------------
 
-+ Python 2.6, 2.7, or 3.1 and newer.
++ Python 2.6, 2.7, or 3.2 and newer.
   Python 2.6 requires patching the sources, see below.
 + `setuptools`_.
 + `pytest`_ 2.8.0 or newer.
 
+(Python 3.1 is not supported by pytest 2.8.0 itself.)
+
 
 Download
 --------

doc/src/usage.rst

@@ -44,10 +44,10 @@ Naming tests
 Tests are referenced by their name in the `depends` argument.  The
 default for this name is the node ID defined by pytest, that is the
 name of the test function, extended by the parameters if applicable.
-As these node IDs may become complicated, the name can be overridden
-by an explicit `name` argument to the marker.  The following example
-works exactly as the last one, only the test names are explicitely
-set:
+In some cases, it's not easy to predict the names of the node IDs.
+For this reason, the name of the tests can be overridden by an
+explicit `name` argument to the marker.  The following example works
+exactly as the last one, only the test names are explicitely set:
 
 .. literalinclude:: ../examples/named.py
 
@@ -100,3 +100,9 @@ Tests `test_c` and `test_d` set their dependencies at runtime calling
 of the `request` pytest fixture, the second argument is the list of
 dependencies.  It has the same effect as passing this list as the
 `depends` argument to the :func:`pytest.mark.dependency` marker.
+
+The present example is certainly somewhat artificial, as the use of
+the :func:`pytest_dependency.depends` function would not be needed in
+such a simple case.  For a more involved example that can not as
+easily be formulated with the static the `depends` argument, see
+:ref:`advanced-grouping-fixtures`.

setup.py

@@ -72,7 +72,6 @@ def make_release_tree(self, base_dir, files):
         'Programming Language :: Python :: 2.6',
         'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.1',
         'Programming Language :: Python :: 3.2',
         'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.4',