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

   how-to/usage
   how-to/assert
   how-to/fixtures
   how-to/mark
   how-to/parametrize
   how-to/tmp_path
   how-to/monkeypatch
   how-to/doctest
   how-to/cache

   how-to/logging
   how-to/capture-stdout-stderr
   how-to/capture-warnings
   how-to/skipping

   how-to/plugins
   how-to/writing_plugins
   how-to/writing_hook_functions

   how-to/existingtestsuite
   how-to/unittest
   how-to/nose
   how-to/xunit_setup

   how-to/bash-completion


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

.. toctree::
   :maxdepth: 2

   reference/fixtures
   reference/plugin_list
   reference/customize
   reference/reference


Explanation
-----------------

.. toctree::
   :maxdepth: 2

   explanation/anatomy
   explanation/fixtures
   explanation/goodpractices
   explanation/flaky
   explanation/pythonpath


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

.. toctree::
   :maxdepth: 2

   example/index

   backwards-compatibility
   deprecations

   contributing
   development_guide

   sponsor
   tidelift
   license
   contact

   history
   historical-notes
   talks


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

Added how-to and reference directories. Moved various documents into subdirectories, how-to and reference. Updated multiple links to use `:ref:` instead of `:doc:`, meaning that files can henceforth be moved around without breaking references. 2021-03-12 04:30:47 +08:00			`how-to/usage`
			`how-to/assert`
Merge pull request #8441 from evildmp/evolutionary-documentation-restructure Moved more sections from reference to how-to. 2021-03-15 16:22:11 +08:00			`how-to/fixtures`
Added how-to and reference directories. Moved various documents into subdirectories, how-to and reference. Updated multiple links to use `:ref:` instead of `:doc:`, meaning that files can henceforth be moved around without breaking references. 2021-03-12 04:30:47 +08:00			`how-to/mark`
Merge pull request #8441 from evildmp/evolutionary-documentation-restructure Moved more sections from reference to how-to. 2021-03-15 16:22:11 +08:00			`how-to/parametrize`
rename tmpdir.rst to tmp_path.rst (#8905) 2021-07-14 23:53:27 +08:00			`how-to/tmp_path`
Merge pull request #8441 from evildmp/evolutionary-documentation-restructure Moved more sections from reference to how-to. 2021-03-15 16:22:11 +08:00			`how-to/monkeypatch`
			`how-to/doctest`
			`how-to/cache`

			`how-to/logging`
			`how-to/capture-stdout-stderr`
			`how-to/capture-warnings`
Added how-to and reference directories. Moved various documents into subdirectories, how-to and reference. Updated multiple links to use `:ref:` instead of `:doc:`, meaning that files can henceforth be moved around without breaking references. 2021-03-12 04:30:47 +08:00			`how-to/skipping`
Merge pull request #8441 from evildmp/evolutionary-documentation-restructure Moved more sections from reference to how-to. 2021-03-15 16:22:11 +08:00
Added how-to and reference directories. Moved various documents into subdirectories, how-to and reference. Updated multiple links to use `:ref:` instead of `:doc:`, meaning that files can henceforth be moved around without breaking references. 2021-03-12 04:30:47 +08:00			`how-to/plugins`
Merge pull request #8441 from evildmp/evolutionary-documentation-restructure Moved more sections from reference to how-to. 2021-03-15 16:22:11 +08:00			`how-to/writing_plugins`
			`how-to/writing_hook_functions`

			`how-to/existingtestsuite`
			`how-to/unittest`
Added how-to and reference directories. Moved various documents into subdirectories, how-to and reference. Updated multiple links to use `:ref:` instead of `:doc:`, meaning that files can henceforth be moved around without breaking references. 2021-03-12 04:30:47 +08:00			`how-to/nose`
Merge pull request #8441 from evildmp/evolutionary-documentation-restructure Moved more sections from reference to how-to. 2021-03-15 16:22:11 +08:00			`how-to/xunit_setup`

Added how-to and reference directories. Moved various documents into subdirectories, how-to and reference. Updated multiple links to use `:ref:` instead of `:doc:`, meaning that files can henceforth be moved around without breaking references. 2021-03-12 04:30:47 +08:00			`how-to/bash-completion`
Moved documentation topics to group them by theme. Reordered items in: * _templates/globaltoc.html * contents.rst 2021-03-12 01:22:54 +08:00

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

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

Split fixtures documentation into separate documents. Sections have been moved to: * reference/fixtures.rst * how-to/fixtures.rst * fixtures.rst according to their function. Further refinement and rewriting will be required. Some material has been moved to a new "Anatomy of a test" document, in anticipation that material from other sections will also find a natural home there later. Removed several unneeded reference targets from fixtures documentation. 2021-03-13 06:16:47 +08:00			`reference/fixtures`
Added how-to and reference directories. Moved various documents into subdirectories, how-to and reference. Updated multiple links to use `:ref:` instead of `:doc:`, meaning that files can henceforth be moved around without breaking references. 2021-03-12 04:30:47 +08:00			`reference/plugin_list`
			`reference/customize`
			`reference/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
Created a new Explanation section and new landing pages for main sections. Added landing pages for: How-to guides Reference guides Explanation Added links to the main landing pages to the sidebar. 2021-03-13 06:57:53 +08:00			`Explanation`
			`-----------------`

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

			`explanation/anatomy`
			`explanation/fixtures`
			`explanation/goodpractices`
			`explanation/flaky`
			`explanation/pythonpath`


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`

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

doc: Add history page (#8784) Based on #8667 2021-06-24 02:26:08 +08:00			`history`
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			`historical-notes`
reshuffle start page as per gutworth feedback 2011-07-07 04:05:48 +08:00			`talks`
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`