Add reference to builtin markers to doc (#7321)

Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
This commit is contained in:
Xinbin Huang 2020-06-05 04:10:16 -07:00 committed by GitHub
parent cc283cfe79
commit 19ad588935
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 3 deletions

View File

@ -4,14 +4,19 @@ Marking test functions with attributes
====================================== ======================================
By using the ``pytest.mark`` helper you can easily set By using the ``pytest.mark`` helper you can easily set
metadata on your test functions. There are metadata on your test functions. You can find the full list of builtin markers
some builtin markers, for example: in the :ref:`API Reference<marks ref>`. Or you can list all the markers, including
builtin and custom, using the CLI - :code:`pytest --markers`.
Here are some of the builtin markers:
* :ref:`usefixtures <usefixtures>` - use fixtures on a test function or class
* :ref:`filterwarnings <filterwarnings>` - filter certain warnings of a test function
* :ref:`skip <skip>` - always skip a test function * :ref:`skip <skip>` - always skip a test function
* :ref:`skipif <skipif>` - skip a test function if a certain condition is met * :ref:`skipif <skipif>` - skip a test function if a certain condition is met
* :ref:`xfail <xfail>` - produce an "expected failure" outcome if a certain * :ref:`xfail <xfail>` - produce an "expected failure" outcome if a certain
condition is met condition is met
* :ref:`parametrize <parametrizemark>` to perform multiple calls * :ref:`parametrize <parametrizemark>` - perform multiple calls
to the same test function. to the same test function.
It's easy to create custom markers or to apply markers It's easy to create custom markers or to apply markers

View File

@ -0,0 +1,5 @@
#!/usr/bin/env bash
MY_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cd "${MY_DIR}"/_build/html || exit
python -m http.server 8000