test_ok1/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>`_

.. toctree::
   :maxdepth: 2

   getting-started
   usage
   existingtestsuite
   assert
   fixture
   mark
   monkeypatch
   tmpdir
   capture
   warnings
   doctest
   skipping
   parametrize
   cache
   unittest
   nose
   xunit_setup
   plugins
   writing_plugins
   logging
   reference

   goodpractices
   flaky
   pythonpath
   customize
   example/index
   bash-completion

   backwards-compatibility
   deprecations
   py27-py34-deprecation
   historical-notes
   license
   contributing
   development_guide
   talks
   projects
   faq
   contact
   tidelift

.. 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>`_

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`
			`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`
			`fixture`
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`
Add docs for the warnings functionality 2017-03-21 10:35:01 +08:00			`warnings`
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			`doctest`
			`skipping`
			`parametrize`
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`
Document limitations for yield-tests in nose Also add nose doc to the root toctree Closes #1716 2016-07-12 23:41:40 +08:00			`nose`
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			`xunit_setup`
			`plugins`
			`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`
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
			`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`
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			`customize`
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			`example/index`
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			`bash-completion`
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`
Move historical notes to their own doc Fix #2512 2017-07-28 07:02:18 +08:00			`historical-notes`
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			`license`
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`
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`
			`faq`
			`contact`
Add link to tidelift to the main docs As commented in: https://github.com/pytest-dev/pytest/pull/5240#issuecomment-494175451 2019-05-21 22:12:07 +08:00			`tidelift`
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`