Merge branch 'master' into release-6.0.0rc1

Author: nicoddemus

CHANGELOG.rst

@@ -2,6 +2,6 @@
 Changelog
 =========
 
-The pytest CHANGELOG is located `here <https://docs.pytest.org/en/latest/changelog.html>`__.
+The pytest CHANGELOG is located `here <https://docs.pytest.org/en/stable/changelog.html>`__.
 
 The source document can be found at: https://github.com/pytest-dev/pytest/blob/master/doc/en/changelog.rst

CONTRIBUTING.rst

@@ -294,7 +294,7 @@ Here is a simple overview, with pytest-specific bits:
 Writing Tests
 ~~~~~~~~~~~~~
 
-Writing tests for plugins or for pytest itself is often done using the `testdir fixture <https://docs.pytest.org/en/latest/reference.html#testdir>`_, as a "black-box" test.
+Writing tests for plugins or for pytest itself is often done using the `testdir fixture <https://docs.pytest.org/en/stable/reference.html#testdir>`_, as a "black-box" test.
 
 For example, to ensure a simple test passes you can write:
 

README.rst

@@ -1,5 +1,5 @@
-.. image:: https://docs.pytest.org/en/latest/_static/pytest1.png
-   :target: https://docs.pytest.org/en/latest/
+.. image:: https://docs.pytest.org/en/stable/_static/pytest1.png
+   :target: https://docs.pytest.org/en/stable/
    :align: center
    :alt: pytest
 
@@ -71,23 +71,23 @@ To execute it::
     ========================== 1 failed in 0.04 seconds ===========================
 
 
-Due to ``pytest``'s detailed assertion introspection, only plain ``assert`` statements are used. See `getting-started <https://docs.pytest.org/en/latest/getting-started.html#our-first-test-run>`_ for more examples.
+Due to ``pytest``'s detailed assertion introspection, only plain ``assert`` statements are used. See `getting-started <https://docs.pytest.org/en/stable/getting-started.html#our-first-test-run>`_ for more examples.
 
 
 Features
 --------
 
-- Detailed info on failing `assert statements <https://docs.pytest.org/en/latest/assert.html>`_ (no need to remember ``self.assert*`` names);
+- Detailed info on failing `assert statements <https://docs.pytest.org/en/stable/assert.html>`_ (no need to remember ``self.assert*`` names);
 
 - `Auto-discovery
-  <https://docs.pytest.org/en/latest/goodpractices.html#python-test-discovery>`_
+  <https://docs.pytest.org/en/stable/goodpractices.html#python-test-discovery>`_
   of test modules and functions;
 
-- `Modular fixtures <https://docs.pytest.org/en/latest/fixture.html>`_ for
+- `Modular fixtures <https://docs.pytest.org/en/stable/fixture.html>`_ for
   managing small or parametrized long-lived test resources;
 
-- Can run `unittest <https://docs.pytest.org/en/latest/unittest.html>`_ (or trial),
-  `nose <https://docs.pytest.org/en/latest/nose.html>`_ test suites out of the box;
+- Can run `unittest <https://docs.pytest.org/en/stable/unittest.html>`_ (or trial),
+  `nose <https://docs.pytest.org/en/stable/nose.html>`_ test suites out of the box;
 
 - Python 3.5+ and PyPy3;
 
@@ -97,7 +97,7 @@ Features
 Documentation
 -------------
 
-For full documentation, including installation, tutorials and PDF documents, please see https://docs.pytest.org/en/latest/.
+For full documentation, including installation, tutorials and PDF documents, please see https://docs.pytest.org/en/stable/.
 
 
 Bugs/Requests
@@ -109,7 +109,7 @@ Please use the `GitHub issue tracker <https://github.com/pytest-dev/pytest/issue
 Changelog
 ---------
 
-Consult the `Changelog <https://docs.pytest.org/en/latest/changelog.html>`__ page for fixes and enhancements of each version.
+Consult the `Changelog <https://docs.pytest.org/en/stable/changelog.html>`__ page for fixes and enhancements of each version.
 
 
 Support pytest

doc/en/_templates/layout.html

@@ -0,0 +1,52 @@
+{#
+
+    Copied from:
+
+     https://raw.githubusercontent.com/pallets/pallets-sphinx-themes/b0c6c41849b4e15cbf62cc1d95c05ef2b3e155c8/src/pallets_sphinx_themes/themes/pocoo/layout.html
+
+    And removed the warning version (see #7331).
+
+#}
+
+{% extends "basic/layout.html" %}
+
+{% set metatags %}
+  {{- metatags }}
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+{%- endset %}
+
+{% block extrahead %}
+  {%- if page_canonical_url %}
+    <link rel="canonical" href="{{ page_canonical_url }}">
+  {%- endif %}
+  <script>DOCUMENTATION_OPTIONS.URL_ROOT = '{{ url_root }}';</script>
+  {{ super() }}
+{%- endblock %}
+
+{% block sidebarlogo %}
+  {% if pagename != "index" or theme_index_sidebar_logo %}
+    {{ super() }}
+  {% endif %}
+{% endblock %}
+
+{% block relbar2 %}{% endblock %}
+
+{% block sidebar2 %}
+  <span id="sidebar-top"></span>
+  {{- super() }}
+{%- endblock %}
+
+{% block footer %}
+  {{ super() }}
+  {%- if READTHEDOCS and not readthedocs_docsearch %}
+    <script>
+      if (typeof READTHEDOCS_DATA !== 'undefined') {
+        if (!READTHEDOCS_DATA.features) {
+          READTHEDOCS_DATA.features = {};
+        }
+        READTHEDOCS_DATA.features.docsearch_disabled = true;
+      }
+    </script>
+  {%- endif %}
+  {{ js_tag("_static/version_warning_offset.js") }}
+{% endblock %}

doc/en/announce/release-2.0.0.rst

@@ -7,7 +7,7 @@ see below for summary and detailed lists.  A lot of long-deprecated code
 has been removed, resulting in a much smaller and cleaner
 implementation.  See the new docs with examples here:
 
-    http://pytest.org/en/latest/index.html
+    http://pytest.org/en/stable/index.html
 
 A note on packaging: pytest used to part of the "py" distribution up
 until version py-1.3.4 but this has changed now:  pytest-2.0.0 only
@@ -36,12 +36,12 @@ New Features
 
     import pytest ; pytest.main(arglist, pluginlist)
 
-  see http://pytest.org/en/latest/usage.html for details.
+  see http://pytest.org/en/stable/usage.html for details.
 
 - new and better reporting information in assert expressions
   if comparing lists, sequences or strings.
 
-  see http://pytest.org/en/latest/assert.html#newreport
+  see http://pytest.org/en/stable/assert.html#newreport
 
 - new configuration through ini-files (setup.cfg or tox.ini recognized),
   for example::
@@ -50,7 +50,7 @@ New Features
     norecursedirs = .hg data*  # don't ever recurse in such dirs
     addopts = -x --pyargs      # add these command line options by default
 
-  see http://pytest.org/en/latest/customize.html
+  see http://pytest.org/en/stable/customize.html
 
 - improved standard unittest support.  In general py.test should now
   better be able to run custom unittest.TestCases like twisted trial

doc/en/announce/release-2.0.1.rst

@@ -57,7 +57,7 @@ Changes between 2.0.0 and 2.0.1
 - refinements to "collecting" output on non-ttys
 - refine internal plugin registration and --traceconfig output
 - introduce a mechanism to prevent/unregister plugins from the
-  command line, see http://pytest.org/en/latest/plugins.html#cmdunregister
+  command line, see http://pytest.org/en/stable/plugins.html#cmdunregister
 - activate resultlog plugin by default
 - fix regression wrt yielded tests which due to the
   collection-before-running semantics were not

doc/en/announce/release-2.1.0.rst

@@ -12,7 +12,7 @@ courtesy of Benjamin Peterson.  You can now safely use ``assert``
 statements in test modules without having to worry about side effects
 or python optimization ("-OO") options.  This is achieved by rewriting
 assert statements in test modules upon import, using a PEP302 hook.
-See https://docs.pytest.org/en/latest/assert.html for
+See https://docs.pytest.org/en/stable/assert.html for
 detailed information.  The work has been partly sponsored by my company,
 merlinux GmbH.
 

doc/en/announce/release-2.2.0.rst

@@ -9,7 +9,7 @@ with these improvements:
 
   - new @pytest.mark.parametrize decorator to run tests with different arguments
   - new metafunc.parametrize() API for parametrizing arguments independently
-  - see examples at http://pytest.org/en/latest/example/parametrize.html
+  - see examples at http://pytest.org/en/stable/example/parametrize.html
   - NOTE that parametrize() related APIs are still a bit experimental
     and might change in future releases.
 
@@ -18,7 +18,7 @@ with these improvements:
   - "-m markexpr" option for selecting tests according to their mark
   - a new "markers" ini-variable for registering test markers for your project
   - the new "--strict" bails out with an error if using unregistered markers.
-  - see examples at http://pytest.org/en/latest/example/markers.html
+  - see examples at http://pytest.org/en/stable/example/markers.html
 
 * duration profiling: new "--duration=N" option showing the N slowest test
   execution or setup/teardown calls. This is most useful if you want to
@@ -78,7 +78,7 @@ Changes between 2.1.3 and 2.2.0
   or through plugin hooks.  Also introduce a "--strict" option which
   will treat unregistered markers as errors
   allowing to avoid typos and maintain a well described set of markers
-  for your test suite.  See examples at http://pytest.org/en/latest/mark.html
+  for your test suite.  See examples at http://pytest.org/en/stable/mark.html
   and its links.
 - issue50: introduce "-m marker" option to select tests based on markers
   (this is a stricter and more predictable version of "-k" in that "-m"

doc/en/announce/release-2.3.0.rst

@@ -13,12 +13,12 @@ re-usable fixture design.
 
 For detailed info and tutorial-style examples, see:
 
-    http://pytest.org/en/latest/fixture.html
+    http://pytest.org/en/stable/fixture.html
 
 Moreover, there is now support for using pytest fixtures/funcargs with
 unittest-style suites, see here for examples:
 
-    http://pytest.org/en/latest/unittest.html
+    http://pytest.org/en/stable/unittest.html
 
 Besides, more unittest-test suites are now expected to "simply work"
 with pytest.
@@ -29,11 +29,11 @@ pytest-2.2.4.
 
 If you are interested in the precise reasoning (including examples) of the
 pytest-2.3 fixture evolution, please consult
-http://pytest.org/en/latest/funcarg_compare.html
+http://pytest.org/en/stable/funcarg_compare.html
 
 For general info on installation and getting started:
 
-    http://pytest.org/en/latest/getting-started.html
+    http://pytest.org/en/stable/getting-started.html
 
 Docs and PDF access as usual at:
 
@@ -94,7 +94,7 @@ Changes between 2.2.4 and 2.3.0
 - pluginmanager.register(...) now raises ValueError if the
   plugin has been already registered or the name is taken
 
-- fix issue159: improve http://pytest.org/en/latest/faq.html
+- fix issue159: improve http://pytest.org/en/stable/faq.html
   especially with respect to the "magic" history, also mention
   pytest-django, trial and unittest integration.
 

doc/en/announce/release-2.3.4.rst

@@ -16,7 +16,7 @@ comes with the following fixes and features:
 - yielded test functions will now have autouse-fixtures active but
   cannot accept fixtures as funcargs - it's anyway recommended to
   rather use the post-2.0 parametrize features instead of yield, see:
-  http://pytest.org/en/latest/example/parametrize.html
+  http://pytest.org/en/stable/example/parametrize.html
 - fix autouse-issue where autouse-fixtures would not be discovered
   if defined in an a/conftest.py file and tests in a/tests/test_some.py
 - fix issue226 - LIFO ordering for fixture teardowns

doc/en/announce/release-2.4.0.rst

@@ -7,7 +7,7 @@ from a few supposedly very minor incompatibilities.  See below for
 a full list of details.  A few feature highlights:
 
 - new yield-style fixtures `pytest.yield_fixture
-  <http://pytest.org/en/latest/yieldfixture.html>`_, allowing to use
+  <http://pytest.org/en/stable/yieldfixture.html>`_, allowing to use
   existing with-style context managers in fixture functions.
 
 - improved pdb support: ``import pdb ; pdb.set_trace()`` now works

doc/en/announce/release-2.7.0.rst

@@ -52,7 +52,7 @@ holger krekel
 - add ability to set command line options by environment variable PYTEST_ADDOPTS.
 
 - added documentation on the new pytest-dev teams on bitbucket and
-  github.  See https://pytest.org/en/latest/contributing.html .
+  github.  See https://pytest.org/en/stable/contributing.html .
   Thanks to Anatoly for pushing and initial work on this.
 
 - fix issue650: new option ``--docttest-ignore-import-errors`` which

doc/en/announce/release-2.9.0.rst

@@ -131,7 +131,7 @@ The py.test Development Team
   with same name.
 
 
-.. _`traceback style docs`: https://pytest.org/en/latest/usage.html#modifying-python-traceback-printing
+.. _`traceback style docs`: https://pytest.org/en/stable/usage.html#modifying-python-traceback-printing
 
 .. _#1422: https://github.com/pytest-dev/pytest/issues/1422
 .. _#1379: https://github.com/pytest-dev/pytest/issues/1379

doc/en/announce/release-3.0.1.rst

@@ -8,7 +8,7 @@ drop-in replacement. To upgrade:
 
   pip install --upgrade pytest
 
-The changelog is available at http://doc.pytest.org/en/latest/changelog.html.
+The changelog is available at http://doc.pytest.org/en/stable/changelog.html.
 
 Thanks to all who contributed to this release, among them:
 

doc/en/announce/release-3.0.2.rst

@@ -8,7 +8,7 @@ drop-in replacement. To upgrade::
 
   pip install --upgrade pytest
 
-The changelog is available at http://doc.pytest.org/en/latest/changelog.html.
+The changelog is available at http://doc.pytest.org/en/stable/changelog.html.
 
 Thanks to all who contributed to this release, among them:
 

doc/en/announce/release-3.0.3.rst

@@ -8,7 +8,7 @@ being a drop-in replacement. To upgrade::
 
   pip install --upgrade pytest
 
-The changelog is available at http://doc.pytest.org/en/latest/changelog.html.
+The changelog is available at http://doc.pytest.org/en/stable/changelog.html.
 
 Thanks to all who contributed to this release, among them:
 

doc/en/announce/release-3.0.4.rst

@@ -8,7 +8,7 @@ being a drop-in replacement. To upgrade::
 
   pip install --upgrade pytest
 
-The changelog is available at http://doc.pytest.org/en/latest/changelog.html.
+The changelog is available at http://doc.pytest.org/en/stable/changelog.html.
 
 Thanks to all who contributed to this release, among them:
 

doc/en/announce/release-3.0.5.rst

@@ -7,7 +7,7 @@ This is a bug-fix release, being a drop-in replacement. To upgrade::
 
   pip install --upgrade pytest
 
-The changelog is available at http://doc.pytest.org/en/latest/changelog.html.
+The changelog is available at http://doc.pytest.org/en/stable/changelog.html.
 
 Thanks to all who contributed to this release, among them:
 

doc/en/announce/release-3.0.6.rst

@@ -7,7 +7,7 @@ This is a bug-fix release, being a drop-in replacement. To upgrade::
 
   pip install --upgrade pytest
 
-The full changelog is available at http://doc.pytest.org/en/latest/changelog.html.
+The full changelog is available at http://doc.pytest.org/en/stable/changelog.html.
 
 
 Thanks to all who contributed to this release, among them:

doc/en/announce/release-3.0.7.rst

@@ -7,7 +7,7 @@ This is a bug-fix release, being a drop-in replacement. To upgrade::
 
   pip install --upgrade pytest
 
-The full changelog is available at http://doc.pytest.org/en/latest/changelog.html.
+The full changelog is available at http://doc.pytest.org/en/stable/changelog.html.
 
 Thanks to all who contributed to this release, among them:
 

doc/en/announce/release-3.1.0.rst

@@ -9,7 +9,7 @@ against itself, passing on many different interpreters and platforms.
 This release contains a bugs fixes and improvements, so users are encouraged
 to take a look at the CHANGELOG:
 
-http://doc.pytest.org/en/latest/changelog.html
+http://doc.pytest.org/en/stable/changelog.html
 
 For complete documentation, please visit:
 

doc/en/announce/release-3.1.1.rst

@@ -7,7 +7,7 @@ This is a bug-fix release, being a drop-in replacement. To upgrade::
 
   pip install --upgrade pytest
 
-The full changelog is available at http://doc.pytest.org/en/latest/changelog.html.
+The full changelog is available at http://doc.pytest.org/en/stable/changelog.html.
 
 Thanks to all who contributed to this release, among them:
 

doc/en/announce/release-3.1.2.rst

@@ -7,7 +7,7 @@ This is a bug-fix release, being a drop-in replacement. To upgrade::
 
   pip install --upgrade pytest
 
-The full changelog is available at http://doc.pytest.org/en/latest/changelog.html.
+The full changelog is available at http://doc.pytest.org/en/stable/changelog.html.
 
 Thanks to all who contributed to this release, among them:
 

doc/en/announce/release-3.1.3.rst

@@ -7,7 +7,7 @@ This is a bug-fix release, being a drop-in replacement. To upgrade::
 
   pip install --upgrade pytest
 
-The full changelog is available at http://doc.pytest.org/en/latest/changelog.html.
+The full changelog is available at http://doc.pytest.org/en/stable/changelog.html.
 
 Thanks to all who contributed to this release, among them:
 

doc/en/announce/release-3.10.0.rst

@@ -9,11 +9,11 @@ against itself, passing on many different interpreters and platforms.
 This release contains a number of bugs fixes and improvements, so users are encouraged
 to take a look at the CHANGELOG:
 
-    https://docs.pytest.org/en/latest/changelog.html
+    https://docs.pytest.org/en/stable/changelog.html
 
 For complete documentation, please visit:
 
-    https://docs.pytest.org/en/latest/
+    https://docs.pytest.org/en/stable/
 
 As usual, you can upgrade from pypi via:
 

doc/en/announce/release-3.10.1.rst

@@ -7,7 +7,7 @@ This is a bug-fix release, being a drop-in replacement. To upgrade::
 
   pip install --upgrade pytest
 
-The full changelog is available at https://docs.pytest.org/en/latest/changelog.html.
+The full changelog is available at https://docs.pytest.org/en/stable/changelog.html.
 
 Thanks to all who contributed to this release, among them: