[svn r63548] fixing lots of little issues with the docs

--HG--
branch : trunk
This commit is contained in:
hpk 2009-04-02 20:59:31 +02:00
parent 069ab6ff5f
commit ca2c19731a
8 changed files with 8 additions and 58 deletions

View File

@ -61,11 +61,5 @@ Miscellaneous
- Try to put the tests close to the tested code, don't - Try to put the tests close to the tested code, don't
overload directories with names. overload directories with names.
- If you think of exporting new py lib APIs, discuss it first on the
`py-dev mailing list`_ and possibly write a chapter in our
`future_` book. Communication is considered a key here to make
sure that the py lib develops in a consistent way.
.. _`PEP 8 Style Guide for Python Code`: http://www.python.org/peps/pep-0008.html .. _`PEP 8 Style Guide for Python Code`: http://www.python.org/peps/pep-0008.html
.. _`py-dev mailing list`: http://codespeak.net/mailman/listinfo/py-dev .. _`py-dev mailing list`: http://codespeak.net/mailman/listinfo/py-dev
.. _`future`: future.html

View File

@ -16,8 +16,6 @@ Contact and communication
.. _`merlinux.eu`: http://merlinux.eu .. _`merlinux.eu`: http://merlinux.eu
.. _future: future.html
.. _`get an account`: .. _`get an account`:
.. _tetamap: http://tetamap.wordpress.com .. _tetamap: http://tetamap.wordpress.com

View File

@ -2,7 +2,6 @@
ATTIC documentation ATTIC documentation
=============================================== ===============================================
XXX REVIEW and remove the below XXX XXX REVIEW and remove the below XXX

View File

@ -33,11 +33,7 @@ Minor support functionality
.. _`py.test`: test.html .. _`py.test`: test.html
.. _`py lib scripts`: bin.html .. _`py lib scripts`: bin.html
.. _`py.xml`: xml.html .. _`py.xml`: xml.html
.. _`Why What how py?`: why_py.html
.. _`future`: future.html
.. _`miscellaneous features`: misc.html .. _`miscellaneous features`: misc.html
.. _`0.9.2 release announcement`: release-0.9.2.html
Full Contents Full Contents
=================================== ===================================
@ -64,4 +60,3 @@ Full Contents
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex` * :ref:`modindex`
* :ref:`search` * :ref:`search`

View File

@ -2,7 +2,6 @@
Miscellaneous features of the py lib Miscellaneous features of the py lib
==================================== ====================================
Mapping the standard python library into py Mapping the standard python library into py
=========================================== ===========================================
@ -52,32 +51,14 @@ However, the ``cmdexec`` approach has a few shortcomings:
local paths have ``sysexec`` local paths have ``sysexec``
---------------------------- ----------------------------
The py lib currently offers a stripped down functionality of what In order to synchronously execute an executable file you
the new `PEP-324 subprocess module`_ offers. The main functionality can use ``sysexec``::
of synchronously executing a system executable has a straightforward API::
binsvn.sysexec('ls', 'http://codespeak.net/svn') binsvn.sysexec('ls', 'http://codespeak.net/svn')
where ``binsvn`` is a path that points to the ``svn`` commandline where ``binsvn`` is a path that points to the ``svn`` commandline
binary. Note that this function would not offer any shell-escaping binary. Note that this function does not offer any shell-escaping
so you really have to pass in separated arguments. This idea so you have to pass in already separated arguments.
fits nicely into `a more general view on path objects`_.
For a first go, we are just reusing the existing `subprocess
implementation`_ but don't expose any of its API apart
from the above ``sysexec()`` method.
Note, however, that currently the support for the ``sysexec`` interface on
win32 is not thoroughly tested. If you run into problems with it, we are
interested to hear about them. If you are running a Python older than 2.4 you
will have to install the `pywin32 package`_.
.. _`future book`: future.html
.. _`PEP-324 subprocess module`: http://www.python.org/peps/pep-0324.html
.. _`subprocess implementation`: http://www.lysator.liu.se/~astrand/popen5/
.. _`a more general view on path objects`: future.html#general-path
.. _`pywin32 package`: http://pywin32.sourceforge.net/
finding an executable local path finding an executable local path
-------------------------------- --------------------------------

View File

@ -51,9 +51,6 @@ home-directoray, per shell session or per test-run.
Test Collection process Test Collection process
====================================================== ======================================================
.. module:: py.test.collect
:synopsis: basic test collection classes
The collecting process is iterative so that distribution The collecting process is iterative so that distribution
and execution of tests can start as soon as the first test and execution of tests can start as soon as the first test
item is collected. Collection nodes with children are item is collected. Collection nodes with children are
@ -110,22 +107,9 @@ name. Given a filesystem ``fspath`` it is constructed as follows:
the trailing ``.py``. the trailing ``.py``.
Plugin hooks and events
Plugin methods
======================================= =======================================
.. module:: py.__.test.pluginapi See definitions at
A Plugin class may implement the following attributes and methods:
XXX
_`pytest event`:
Pytest Events
=======================================
XXX
http://codespeak.net/svn/py/trunk/py/test/plugin/api.py

View File

@ -23,7 +23,7 @@ From each test module every function with a leading ``test_``
or class with a leading ``Test`` name is collected. or class with a leading ``Test`` name is collected.
.. _`generative tests`: .. _`generative tests`:
.. _`collection process`: impl-test.html#collection-process .. _`collection process`: test-ext.html#collection-process
load-balance tests to multiple CPUs load-balance tests to multiple CPUs
=================================== ===================================

View File

@ -24,7 +24,6 @@ extend_: writing plugins and advanced configuration.
.. _`distributed testing`: test-dist.html .. _`distributed testing`: test-dist.html
Contents: Contents:
.. toctree:: .. toctree::