fix documentation gegeneration, kill Makefile

Author: RonnyPfannschmidt

Makefile

@@ -12,6 +12,13 @@ PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
+REGENDOC_ARGS := \
+	--normalize "/={8,} (.*) ={8,}/======= \1 ========/" \
+	--normalize "/_{8,} (.*) _{8,}/_______ \1 ________/" \
+	--normalize "/in \d+.\d+ seconds/in 0.12 seconds/" \
+	--normalize "@/tmp/pytest-of-.*/pytest-\d+@PYTEST_TMPDIR@" \
+
+
 
 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
 
@@ -46,7 +53,7 @@ installall: clean install installpdf
 	@echo "done"
 
 regen:
-	PYTHONDONTWRITEBYTECODE=1 COLUMNS=76 regendoc --update *.rst */*.rst
+	PYTHONDONTWRITEBYTECODE=1 COLUMNS=76 regendoc --update *.rst */*.rst ${REGENDOC_ARGS}
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

doc/en/Makefile

@@ -26,7 +26,7 @@ you will see the return value of the function call::
 
     $ py.test test_assert1.py
     ======= test session starts ========
-    platform linux2 -- Python 2.7.9, pytest-2.8.0.dev4, py-1.4.28, pluggy-0.3.0
+    platform linux2 -- Python 2.7.10, pytest-2.8.0, py-1.4.30, pluggy-0.3.1
     rootdir: $REGENDOC_TMPDIR, inifile: 
     collected 1 items
     
@@ -146,7 +146,7 @@ if you run this module::
 
     $ py.test test_assert2.py
     ======= test session starts ========
-    platform linux2 -- Python 2.7.9, pytest-2.8.0.dev4, py-1.4.28, pluggy-0.3.0
+    platform linux2 -- Python 2.7.10, pytest-2.8.0, py-1.4.30, pluggy-0.3.1
     rootdir: $REGENDOC_TMPDIR, inifile: 
     collected 1 items
     
@@ -225,7 +225,7 @@ the conftest file::
    E       assert Comparing Foo instances:
    E            vals: 1 != 2
    
-   test_foocompare.py:8: AssertionError
+   test_foocompare.py:11: AssertionError
    1 failed in 0.12 seconds
 
 .. _assert-details:

doc/en/assert.rst

@@ -73,6 +73,8 @@ You can ask for available builtin or project-custom
 :ref:`fixtures <fixtures>` by typing::
 
     $ py.test -q --fixtures
+    cache
+        /home/private/Projects/pytest-dev/pytest/.tox/regen/lib/python2.7/site-packages/_pytest/cacheprovider.py:176: no docstring available
     capsys
         enables capturing of writes to sys.stdout/sys.stderr and makes
         captured output available via ``capsys.readouterr()`` method calls
@@ -81,6 +83,10 @@ You can ask for available builtin or project-custom
         enables capturing of writes to file descriptors 1 and 2 and makes
         captured output available via ``capfd.readouterr()`` method calls
         which return a ``(out, err)`` tuple.
+    record_xml_property
+        Fixture that adds extra xml properties to the tag for the calling test.
+        The fixture is callable with (name, value), with value being automatically
+        xml-encoded.
     monkeypatch
         The returned ``monkeypatch`` funcarg provides these
         helper methods to modify objects, dictionaries or os.environ::
@@ -108,6 +114,8 @@ You can ask for available builtin or project-custom
         
         See http://docs.python.org/library/warnings.html for information
         on warning categories.
+    tmpdir_factory
+        Return a TempdirFactory instance for the test session.
     tmpdir
         return a temporary directory path object
         which is unique to each test function invocation,

doc/en/builtin.rst

@@ -44,8 +44,8 @@ If you run this for the first time you will see two failures::
 
     $ py.test -q
     .................F.......F........................
-    ================================= FAILURES =================================
-    _______________________________ test_num[17] _______________________________
+    ======= FAILURES ========
+    _______ test_num[17] ________
     
     i = 17
     
@@ -56,7 +56,7 @@ If you run this for the first time you will see two failures::
     E          Failed: bad luck
     
     test_50.py:6: Failed
-    _______________________________ test_num[25] _______________________________
+    _______ test_num[25] ________
     
     i = 25
     
@@ -67,21 +67,21 @@ If you run this for the first time you will see two failures::
     E          Failed: bad luck
     
     test_50.py:6: Failed
-    2 failed, 48 passed in 0.04 seconds
+    2 failed, 48 passed in 0.12 seconds
 
 If you then run it with ``--lf``::
 
     $ py.test --lf
-    =========================== test session starts ============================
-    platform linux2 -- Python 2.7.6, pytest-2.7.3.dev428+ng79d22bf.d20150916, py-1.4.30, pluggy-0.3.0
+    ======= test session starts ========
+    platform linux2 -- Python 2.7.10, pytest-2.8.0, py-1.4.30, pluggy-0.3.1
     run-last-failure: rerun last 2 failures
-    rootdir: /tmp/doc-exec-94, inifile: 
+    rootdir: $REGENDOC_TMPDIR, inifile: 
     collected 50 items
     
     test_50.py FF
     
-    ================================= FAILURES =================================
-    _______________________________ test_num[17] _______________________________
+    ======= FAILURES ========
+    _______ test_num[17] ________
     
     i = 17
     
@@ -92,7 +92,7 @@ If you then run it with ``--lf``::
     E          Failed: bad luck
     
     test_50.py:6: Failed
-    _______________________________ test_num[25] _______________________________
+    _______ test_num[25] ________
     
     i = 25
     
@@ -103,7 +103,7 @@ If you then run it with ``--lf``::
     E          Failed: bad luck
     
     test_50.py:6: Failed
-    ================= 2 failed, 48 deselected in 0.01 seconds ==================
+    ======= 2 failed, 48 deselected in 0.12 seconds ========
 
 You have run only the two failing test from the last run, while 48 tests have
 not been run ("deselected").
@@ -113,16 +113,16 @@ previous failures will be executed first (as can be seen from the series
 of ``FF`` and dots)::
 
     $ py.test --ff
-    =========================== test session starts ============================
-    platform linux2 -- Python 2.7.6, pytest-2.7.3.dev428+ng79d22bf.d20150916, py-1.4.30, pluggy-0.3.0
+    ======= test session starts ========
+    platform linux2 -- Python 2.7.10, pytest-2.8.0, py-1.4.30, pluggy-0.3.1
     run-last-failure: rerun last 2 failures first
-    rootdir: /tmp/doc-exec-94, inifile: 
+    rootdir: $REGENDOC_TMPDIR, inifile: 
     collected 50 items
     
     test_50.py FF................................................
     
-    ================================= FAILURES =================================
-    _______________________________ test_num[17] _______________________________
+    ======= FAILURES ========
+    _______ test_num[17] ________
     
     i = 17
     
@@ -133,7 +133,7 @@ of ``FF`` and dots)::
     E          Failed: bad luck
     
     test_50.py:6: Failed
-    _______________________________ test_num[25] _______________________________
+    _______ test_num[25] ________
     
     i = 25
     
@@ -144,7 +144,7 @@ of ``FF`` and dots)::
     E          Failed: bad luck
     
     test_50.py:6: Failed
-    =================== 2 failed, 48 passed in 0.03 seconds ====================
+    ======= 2 failed, 48 passed in 0.12 seconds ========
 
 .. _`config.cache`:
 
@@ -179,8 +179,8 @@ of the sleep::
 
     $ py.test -q
     F
-    ================================= FAILURES =================================
-    ______________________________ test_function _______________________________
+    ======= FAILURES ========
+    _______ test_function ________
     
     mydata = 42
     
@@ -189,15 +189,15 @@ of the sleep::
     E       assert 42 == 23
     
     test_caching.py:14: AssertionError
-    1 failed in 5.41 seconds
+    1 failed in 0.12 seconds
 
 If you run it a second time the value will be retrieved from
 the cache and this will be quick::
 
     $ py.test -q
     F
-    ================================= FAILURES =================================
-    ______________________________ test_function _______________________________
+    ======= FAILURES ========
+    _______ test_function ________
     
     mydata = 42
     
@@ -206,7 +206,7 @@ the cache and this will be quick::
     E       assert 42 == 23
     
     test_caching.py:14: AssertionError
-    1 failed in 0.01 seconds
+    1 failed in 0.12 seconds
 
 See the `cache-api`_ for more details.
 
@@ -218,15 +218,15 @@ You can always peek at the content of the cache using the
 ``--cache-clear`` command line option::
 
     $ py.test --cache-clear
-    =========================== test session starts ============================
-    platform linux2 -- Python 2.7.6, pytest-2.7.3.dev428+ng79d22bf.d20150916, py-1.4.30, pluggy-0.3.0
-    rootdir: /tmp/doc-exec-94, inifile: 
+    ======= test session starts ========
+    platform linux2 -- Python 2.7.10, pytest-2.8.0, py-1.4.30, pluggy-0.3.1
+    rootdir: $REGENDOC_TMPDIR, inifile: 
     collected 1 items
     
     test_caching.py F
     
-    ================================= FAILURES =================================
-    ______________________________ test_function _______________________________
+    ======= FAILURES ========
+    _______ test_function ________
     
     mydata = 42
     
@@ -235,7 +235,7 @@ You can always peek at the content of the cache using the
     E       assert 42 == 23
     
     test_caching.py:14: AssertionError
-    ========================= 1 failed in 5.41 seconds =========================
+    ======= 1 failed in 0.12 seconds ========
 
 Clearing Cache content
 -------------------------------

doc/en/cache.rst

@@ -64,7 +64,7 @@ of the failing function and hide the other one::
 
     $ py.test
     ======= test session starts ========
-    platform linux2 -- Python 2.7.9, pytest-2.8.0.dev4, py-1.4.28, pluggy-0.3.0
+    platform linux2 -- Python 2.7.10, pytest-2.8.0, py-1.4.30, pluggy-0.3.1
     rootdir: $REGENDOC_TMPDIR, inifile: 
     collected 2 items
     
@@ -78,7 +78,7 @@ of the failing function and hide the other one::
     E       assert False
     
     test_module.py:9: AssertionError
-    ---------------------------- Captured stdout setup -----------------------------
+    -------------------------- Captured stdout setup ---------------------------
     setting up <function test_func2 at 0xdeadbeef>
     ======= 1 failed, 1 passed in 0.12 seconds ========
 

doc/en/capture.rst

@@ -46,7 +46,7 @@ then you can just invoke ``py.test`` without command line options::
 
     $ py.test
     ======= test session starts ========
-    platform linux2 -- Python 2.7.9, pytest-2.8.0.dev4, py-1.4.28, pluggy-0.3.0
+    platform linux2 -- Python 2.7.10, pytest-2.8.0, py-1.4.30, pluggy-0.3.1
     rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
     collected 1 items