test_ok2/doc/en/contents.rst

.. _toc:

Full pytest documentation
===========================

`Download latest version as PDF <https://media.readthedocs.org/pdf/pytest/latest/pytest.pdf>`_

.. `Download latest version as EPUB <http://media.readthedocs.org/epub/pytest/latest/pytest.epub>`_


Start here
-----------

.. toctree::
   :maxdepth: 2

   getting-started


How-to guides
-------------

.. toctree::
   :maxdepth: 2

   usage
   existingtestsuite
   assert
   mark
   monkeypatch
   tmpdir
   capture
   skipping
   parametrize
   plugins
   nose
   bash-completion


Reference guides
-----------------

.. toctree::
   :maxdepth: 2

   fixture
   warnings
   doctest
   cache
   unittest
   xunit_setup
   plugin_list
   writing_plugins
   logging
   customize
   reference


Further topics
-----------------

.. toctree::
   :maxdepth: 2

   goodpractices
   flaky
   pythonpath
   example/index

   backwards-compatibility
   deprecations
   py27-py34-deprecation

   contributing
   development_guide

   sponsor
   tidelift
   license
   contact

   historical-notes
   talks
   projects


.. only:: html

   .. toctree::
      :maxdepth: 1

      announce/index

.. only:: html

   .. toctree::
      :hidden:
      :maxdepth: 1

      changelog
reshuffle start page as per gutworth feedback 2011-07-07 04:05:48 +08:00			`.. _toc:`

fix issue118 - typo 2012-02-02 19:24:12 +08:00			`Full pytest documentation`
			`===========================`
reshuffle start page as per gutworth feedback 2011-07-07 04:05:48 +08:00
Fix pdf links in the documentation Fix #1436 2016-07-27 07:20:22 +08:00			`Download latest version as PDF <https://media.readthedocs.org/pdf/pytest/latest/pytest.pdf>`_
fix issue 35 - provide download link and improved PDF version 2011-07-08 18:42:26 +08:00
			.. `Download latest version as EPUB <http://media.readthedocs.org/epub/pytest/latest/pytest.epub>`_

Moved documentation topics to group them by theme. Reordered items in: * _templates/globaltoc.html * contents.rst 2021-03-12 01:22:54 +08:00
			`Start here`
			`-----------`

reshuffle start page as per gutworth feedback 2011-07-07 04:05:48 +08:00			`.. toctree::`
			`:maxdepth: 2`

docs warnings as errors and initial page similar to README * Changed "index" to be more similar to the README (#1708). * Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432). * Mention all docs in "contents.rst" so it's easier for users to locate (#1112). * Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors. Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829 2016-08-23 10:35:41 +08:00			`getting-started`
Moved documentation topics to group them by theme. Reordered items in: * _templates/globaltoc.html * contents.rst 2021-03-12 01:22:54 +08:00

			`How-to guides`
			`-------------`

			`.. toctree::`
			`:maxdepth: 2`

docs warnings as errors and initial page similar to README * Changed "index" to be more similar to the README (#1708). * Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432). * Mention all docs in "contents.rst" so it's easier for users to locate (#1112). * Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors. Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829 2016-08-23 10:35:41 +08:00			`usage`
add existing test suite page to table of contents 2016-09-28 05:01:54 +08:00			`existingtestsuite`
docs warnings as errors and initial page similar to README * Changed "index" to be more similar to the README (#1708). * Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432). * Mention all docs in "contents.rst" so it's easier for users to locate (#1112). * Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors. Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829 2016-08-23 10:35:41 +08:00			`assert`
Improve changelog note about markers Also changed the title in the docs because the previous title had the same level as the title, making it appear in a separate entry in `contents.rst` 2018-05-02 06:27:53 +08:00			`mark`
Add reference to some builtin fixtures in "contents" Fix #1408 2016-02-23 07:42:39 +08:00			`monkeypatch`
			`tmpdir`
			`capture`
docs warnings as errors and initial page similar to README * Changed "index" to be more similar to the README (#1708). * Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432). * Mention all docs in "contents.rst" so it's easier for users to locate (#1112). * Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors. Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829 2016-08-23 10:35:41 +08:00			`skipping`
			`parametrize`
Moved documentation topics to group them by theme. Reordered items in: * _templates/globaltoc.html * contents.rst 2021-03-12 01:22:54 +08:00			`plugins`
			`nose`
			`bash-completion`


			`Reference guides`
			`-----------------`

			`.. toctree::`
			`:maxdepth: 2`

			`fixture`
			`warnings`
			`doctest`
Reorganize "Contents" page Change the organization in a more logical way to a newcomer 2015-09-26 12:09:50 +08:00			`cache`
docs warnings as errors and initial page similar to README * Changed "index" to be more similar to the README (#1708). * Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432). * Mention all docs in "contents.rst" so it's easier for users to locate (#1112). * Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors. Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829 2016-08-23 10:35:41 +08:00			`unittest`
			`xunit_setup`
Add plugin list 2021-01-29 22:19:54 +08:00			`plugin_list`
docs warnings as errors and initial page similar to README * Changed "index" to be more similar to the README (#1708). * Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432). * Mention all docs in "contents.rst" so it's easier for users to locate (#1112). * Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors. Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829 2016-08-23 10:35:41 +08:00			`writing_plugins`
Move logging docu into own rst file Remove reference of pytest-catchlog plugin in plugins.rst 2017-09-27 06:39:41 +08:00			`logging`
Moved documentation topics to group them by theme. Reordered items in: * _templates/globaltoc.html * contents.rst 2021-03-12 01:22:54 +08:00			`customize`
Create reference and moved Objects and Hooks reference from writing_plugins 2018-02-08 06:53:31 +08:00			`reference`
docs warnings as errors and initial page similar to README * Changed "index" to be more similar to the README (#1708). * Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432). * Mention all docs in "contents.rst" so it's easier for users to locate (#1112). * Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors. Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829 2016-08-23 10:35:41 +08:00
Moved documentation topics to group them by theme. Reordered items in: * _templates/globaltoc.html * contents.rst 2021-03-12 01:22:54 +08:00
			`Further topics`
			`-----------------`

			`.. toctree::`
			`:maxdepth: 2`

docs warnings as errors and initial page similar to README * Changed "index" to be more similar to the README (#1708). * Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432). * Mention all docs in "contents.rst" so it's easier for users to locate (#1112). * Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors. Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829 2016-08-23 10:35:41 +08:00			`goodpractices`
Fix linting 2018-10-31 21:44:43 +08:00			`flaky`
Clarify PYTHONPATH changes and ``rootdir`` roles - Also minor adjustments in the docs (wording, formatting, links, etc). Fix #2589 2017-07-20 08:11:17 +08:00			`pythonpath`
			`example/index`
Add reference to some builtin fixtures in "contents" Fix #1408 2016-02-23 07:42:39 +08:00
add backwards compatibility policy 2016-07-18 03:14:16 +08:00			`backwards-compatibility`
[WIP] Introduce deprecations page fix #3996 2018-09-19 07:56:40 +08:00			`deprecations`
Add docs page about plans for dropping py27 and py34 Fix #4635 2019-01-15 07:50:10 +08:00			`py27-py34-deprecation`
Update Tidelift docs with latest campaign Tidelift has launched a new marketing campaign as outlined here: * https://forum.tidelift.com/t/task-enhancement-marketing-the-tidelift-subscription-to-your-users/321 This PR splits the previous "sponsor" information into two, Open Collective and Tidelift (as they have very different target audiences). Also took the opportunity to reorder some items at the end of the contents page in a manner that I believe make more sense. 2019-10-25 01:58:58 +08:00
Reorganize "Contents" page Change the organization in a more logical way to a newcomer 2015-09-26 12:09:50 +08:00			`contributing`
Add development guide to docs 2017-09-08 04:48:34 +08:00			`development_guide`
Update Tidelift docs with latest campaign Tidelift has launched a new marketing campaign as outlined here: * https://forum.tidelift.com/t/task-enhancement-marketing-the-tidelift-subscription-to-your-users/321 This PR splits the previous "sponsor" information into two, Open Collective and Tidelift (as they have very different target audiences). Also took the opportunity to reorder some items at the end of the contents page in a manner that I believe make more sense. 2019-10-25 01:58:58 +08:00
			`sponsor`
			`tidelift`
			`license`
			`contact`

			`historical-notes`
reshuffle start page as per gutworth feedback 2011-07-07 04:05:48 +08:00			`talks`
docs warnings as errors and initial page similar to README * Changed "index" to be more similar to the README (#1708). * Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432). * Mention all docs in "contents.rst" so it's easier for users to locate (#1112). * Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors. Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829 2016-08-23 10:35:41 +08:00			`projects`
Update Tidelift docs with latest campaign Tidelift has launched a new marketing campaign as outlined here: * https://forum.tidelift.com/t/task-enhancement-marketing-the-tidelift-subscription-to-your-users/321 This PR splits the previous "sponsor" information into two, Open Collective and Tidelift (as they have very different target audiences). Also took the opportunity to reorder some items at the end of the contents page in a manner that I believe make more sense. 2019-10-25 01:58:58 +08:00
reshuffle start page as per gutworth feedback 2011-07-07 04:05:48 +08:00
hide some parts from generating latexpdf 2015-09-29 19:37:30 +08:00			`.. only:: html`
Fix contents.rst. This was broken in 787c866191e8f845b71e0ccf45710b59e64cfab8. 2015-10-08 00:10:13 +08:00
hide some parts from generating latexpdf 2015-09-29 19:37:30 +08:00			`.. toctree::`
docs warnings as errors and initial page similar to README * Changed "index" to be more similar to the README (#1708). * Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432). * Mention all docs in "contents.rst" so it's easier for users to locate (#1112). * Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors. Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829 2016-08-23 10:35:41 +08:00			`:maxdepth: 1`
hide some parts from generating latexpdf 2015-09-29 19:37:30 +08:00
			`announce/index`

			`.. only:: html`
Fix contents.rst. This was broken in 787c866191e8f845b71e0ccf45710b59e64cfab8. 2015-10-08 00:10:13 +08:00
hide some parts from generating latexpdf 2015-09-29 19:37:30 +08:00			`.. toctree::`
			`:hidden:`
docs warnings as errors and initial page similar to README * Changed "index" to be more similar to the README (#1708). * Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432). * Mention all docs in "contents.rst" so it's easier for users to locate (#1112). * Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors. Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829 2016-08-23 10:35:41 +08:00			`:maxdepth: 1`
reshuffle start page as per gutworth feedback 2011-07-07 04:05:48 +08:00
hide some parts from generating latexpdf 2015-09-29 19:37:30 +08:00			`changelog`